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

oci.FileStorage.Export

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v1.31.0 published on Wednesday, Apr 10, 2024 by Pulumi

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

    Creates a new export in the specified export set, path, and file system.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as oci from "@pulumi/oci";
    
    const testExport = new oci.filestorage.Export("testExport", {
        exportSetId: oci_file_storage_export_set.test_export_set.id,
        fileSystemId: oci_file_storage_file_system.test_file_system.id,
        path: _var.export_path,
        exportOptions: [{
            source: _var.export_export_options_source,
            access: _var.export_export_options_access,
            allowedAuths: _var.export_export_options_allowed_auth,
            anonymousGid: _var.export_export_options_anonymous_gid,
            anonymousUid: _var.export_export_options_anonymous_uid,
            identitySquash: _var.export_export_options_identity_squash,
            isAnonymousAccessAllowed: _var.export_export_options_is_anonymous_access_allowed,
            requirePrivilegedSourcePort: _var.export_export_options_require_privileged_source_port,
        }],
        isIdmapGroupsForSysAuth: _var.export_is_idmap_groups_for_sys_auth,
    });
    
    import pulumi
    import pulumi_oci as oci
    
    test_export = oci.file_storage.Export("testExport",
        export_set_id=oci_file_storage_export_set["test_export_set"]["id"],
        file_system_id=oci_file_storage_file_system["test_file_system"]["id"],
        path=var["export_path"],
        export_options=[oci.file_storage.ExportExportOptionArgs(
            source=var["export_export_options_source"],
            access=var["export_export_options_access"],
            allowed_auths=var["export_export_options_allowed_auth"],
            anonymous_gid=var["export_export_options_anonymous_gid"],
            anonymous_uid=var["export_export_options_anonymous_uid"],
            identity_squash=var["export_export_options_identity_squash"],
            is_anonymous_access_allowed=var["export_export_options_is_anonymous_access_allowed"],
            require_privileged_source_port=var["export_export_options_require_privileged_source_port"],
        )],
        is_idmap_groups_for_sys_auth=var["export_is_idmap_groups_for_sys_auth"])
    
    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.NewExport(ctx, "testExport", &FileStorage.ExportArgs{
    			ExportSetId:  pulumi.Any(oci_file_storage_export_set.Test_export_set.Id),
    			FileSystemId: pulumi.Any(oci_file_storage_file_system.Test_file_system.Id),
    			Path:         pulumi.Any(_var.Export_path),
    			ExportOptions: filestorage.ExportExportOptionArray{
    				&filestorage.ExportExportOptionArgs{
    					Source:                      pulumi.Any(_var.Export_export_options_source),
    					Access:                      pulumi.Any(_var.Export_export_options_access),
    					AllowedAuths:                pulumi.Any(_var.Export_export_options_allowed_auth),
    					AnonymousGid:                pulumi.Any(_var.Export_export_options_anonymous_gid),
    					AnonymousUid:                pulumi.Any(_var.Export_export_options_anonymous_uid),
    					IdentitySquash:              pulumi.Any(_var.Export_export_options_identity_squash),
    					IsAnonymousAccessAllowed:    pulumi.Any(_var.Export_export_options_is_anonymous_access_allowed),
    					RequirePrivilegedSourcePort: pulumi.Any(_var.Export_export_options_require_privileged_source_port),
    				},
    			},
    			IsIdmapGroupsForSysAuth: pulumi.Any(_var.Export_is_idmap_groups_for_sys_auth),
    		})
    		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 testExport = new Oci.FileStorage.Export("testExport", new()
        {
            ExportSetId = oci_file_storage_export_set.Test_export_set.Id,
            FileSystemId = oci_file_storage_file_system.Test_file_system.Id,
            Path = @var.Export_path,
            ExportOptions = new[]
            {
                new Oci.FileStorage.Inputs.ExportExportOptionArgs
                {
                    Source = @var.Export_export_options_source,
                    Access = @var.Export_export_options_access,
                    AllowedAuths = @var.Export_export_options_allowed_auth,
                    AnonymousGid = @var.Export_export_options_anonymous_gid,
                    AnonymousUid = @var.Export_export_options_anonymous_uid,
                    IdentitySquash = @var.Export_export_options_identity_squash,
                    IsAnonymousAccessAllowed = @var.Export_export_options_is_anonymous_access_allowed,
                    RequirePrivilegedSourcePort = @var.Export_export_options_require_privileged_source_port,
                },
            },
            IsIdmapGroupsForSysAuth = @var.Export_is_idmap_groups_for_sys_auth,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.oci.FileStorage.Export;
    import com.pulumi.oci.FileStorage.ExportArgs;
    import com.pulumi.oci.FileStorage.inputs.ExportExportOptionArgs;
    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 testExport = new Export("testExport", ExportArgs.builder()        
                .exportSetId(oci_file_storage_export_set.test_export_set().id())
                .fileSystemId(oci_file_storage_file_system.test_file_system().id())
                .path(var_.export_path())
                .exportOptions(ExportExportOptionArgs.builder()
                    .source(var_.export_export_options_source())
                    .access(var_.export_export_options_access())
                    .allowedAuths(var_.export_export_options_allowed_auth())
                    .anonymousGid(var_.export_export_options_anonymous_gid())
                    .anonymousUid(var_.export_export_options_anonymous_uid())
                    .identitySquash(var_.export_export_options_identity_squash())
                    .isAnonymousAccessAllowed(var_.export_export_options_is_anonymous_access_allowed())
                    .requirePrivilegedSourcePort(var_.export_export_options_require_privileged_source_port())
                    .build())
                .isIdmapGroupsForSysAuth(var_.export_is_idmap_groups_for_sys_auth())
                .build());
    
        }
    }
    
    resources:
      testExport:
        type: oci:FileStorage:Export
        properties:
          #Required
          exportSetId: ${oci_file_storage_export_set.test_export_set.id}
          fileSystemId: ${oci_file_storage_file_system.test_file_system.id}
          path: ${var.export_path}
          #Optional
          exportOptions:
            - source: ${var.export_export_options_source}
              access: ${var.export_export_options_access}
              allowedAuths: ${var.export_export_options_allowed_auth}
              anonymousGid: ${var.export_export_options_anonymous_gid}
              anonymousUid: ${var.export_export_options_anonymous_uid}
              identitySquash: ${var.export_export_options_identity_squash}
              isAnonymousAccessAllowed: ${var.export_export_options_is_anonymous_access_allowed}
              requirePrivilegedSourcePort: ${var.export_export_options_require_privileged_source_port}
          isIdmapGroupsForSysAuth: ${var.export_is_idmap_groups_for_sys_auth}
    

    Create Export Resource

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

    Constructor syntax

    new Export(name: string, args: ExportArgs, opts?: CustomResourceOptions);
    @overload
    def Export(resource_name: str,
               args: ExportArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Export(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               export_set_id: Optional[str] = None,
               file_system_id: Optional[str] = None,
               path: Optional[str] = None,
               export_options: Optional[Sequence[_filestorage.ExportExportOptionArgs]] = None,
               is_idmap_groups_for_sys_auth: Optional[bool] = None)
    func NewExport(ctx *Context, name string, args ExportArgs, opts ...ResourceOption) (*Export, error)
    public Export(string name, ExportArgs args, CustomResourceOptions? opts = null)
    public Export(String name, ExportArgs args)
    public Export(String name, ExportArgs args, CustomResourceOptions options)
    
    type: oci:FileStorage:Export
    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 ExportArgs
    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 ExportArgs
    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 ExportArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ExportArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ExportArgs
    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 exportResource = new Oci.FileStorage.Export("exportResource", new()
    {
        ExportSetId = "string",
        FileSystemId = "string",
        Path = "string",
        ExportOptions = new[]
        {
            new Oci.FileStorage.Inputs.ExportExportOptionArgs
            {
                Source = "string",
                Access = "string",
                AllowedAuths = new[]
                {
                    "string",
                },
                AnonymousGid = "string",
                AnonymousUid = "string",
                IdentitySquash = "string",
                IsAnonymousAccessAllowed = false,
                RequirePrivilegedSourcePort = false,
            },
        },
        IsIdmapGroupsForSysAuth = false,
    });
    
    example, err := FileStorage.NewExport(ctx, "exportResource", &FileStorage.ExportArgs{
    	ExportSetId:  pulumi.String("string"),
    	FileSystemId: pulumi.String("string"),
    	Path:         pulumi.String("string"),
    	ExportOptions: filestorage.ExportExportOptionArray{
    		&filestorage.ExportExportOptionArgs{
    			Source: pulumi.String("string"),
    			Access: pulumi.String("string"),
    			AllowedAuths: pulumi.StringArray{
    				pulumi.String("string"),
    			},
    			AnonymousGid:                pulumi.String("string"),
    			AnonymousUid:                pulumi.String("string"),
    			IdentitySquash:              pulumi.String("string"),
    			IsAnonymousAccessAllowed:    pulumi.Bool(false),
    			RequirePrivilegedSourcePort: pulumi.Bool(false),
    		},
    	},
    	IsIdmapGroupsForSysAuth: pulumi.Bool(false),
    })
    
    var exportResource = new Export("exportResource", ExportArgs.builder()        
        .exportSetId("string")
        .fileSystemId("string")
        .path("string")
        .exportOptions(ExportExportOptionArgs.builder()
            .source("string")
            .access("string")
            .allowedAuths("string")
            .anonymousGid("string")
            .anonymousUid("string")
            .identitySquash("string")
            .isAnonymousAccessAllowed(false)
            .requirePrivilegedSourcePort(false)
            .build())
        .isIdmapGroupsForSysAuth(false)
        .build());
    
    export_resource = oci.file_storage.Export("exportResource",
        export_set_id="string",
        file_system_id="string",
        path="string",
        export_options=[oci.file_storage.ExportExportOptionArgs(
            source="string",
            access="string",
            allowed_auths=["string"],
            anonymous_gid="string",
            anonymous_uid="string",
            identity_squash="string",
            is_anonymous_access_allowed=False,
            require_privileged_source_port=False,
        )],
        is_idmap_groups_for_sys_auth=False)
    
    const exportResource = new oci.filestorage.Export("exportResource", {
        exportSetId: "string",
        fileSystemId: "string",
        path: "string",
        exportOptions: [{
            source: "string",
            access: "string",
            allowedAuths: ["string"],
            anonymousGid: "string",
            anonymousUid: "string",
            identitySquash: "string",
            isAnonymousAccessAllowed: false,
            requirePrivilegedSourcePort: false,
        }],
        isIdmapGroupsForSysAuth: false,
    });
    
    type: oci:FileStorage:Export
    properties:
        exportOptions:
            - access: string
              allowedAuths:
                - string
              anonymousGid: string
              anonymousUid: string
              identitySquash: string
              isAnonymousAccessAllowed: false
              requirePrivilegedSourcePort: false
              source: string
        exportSetId: string
        fileSystemId: string
        isIdmapGroupsForSysAuth: false
        path: string
    

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

    ExportSetId string
    The OCID of this export's export set.
    FileSystemId string
    The OCID of this export's file system.
    Path string

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

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

    ExportOptions List<ExportExportOption>

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    IsIdmapGroupsForSysAuth bool
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    ExportSetId string
    The OCID of this export's export set.
    FileSystemId string
    The OCID of this export's file system.
    Path string

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

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

    ExportOptions []ExportExportOptionArgs

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    IsIdmapGroupsForSysAuth bool
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    exportSetId String
    The OCID of this export's export set.
    fileSystemId String
    The OCID of this export's file system.
    path String

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

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

    exportOptions List<ExportExportOption>

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    isIdmapGroupsForSysAuth Boolean
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    exportSetId string
    The OCID of this export's export set.
    fileSystemId string
    The OCID of this export's file system.
    path string

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

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

    exportOptions ExportExportOption[]

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    isIdmapGroupsForSysAuth boolean
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    export_set_id str
    The OCID of this export's export set.
    file_system_id str
    The OCID of this export's file system.
    path str

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

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

    export_options Sequence[filestorage.ExportExportOptionArgs]

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    is_idmap_groups_for_sys_auth bool
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    exportSetId String
    The OCID of this export's export set.
    fileSystemId String
    The OCID of this export's file system.
    path String

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

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

    exportOptions List<Property Map>

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    isIdmapGroupsForSysAuth Boolean
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    State string
    The current state of this export.
    TimeCreated string
    The date and time the export 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.
    State string
    The current state of this export.
    TimeCreated string
    The date and time the export 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.
    state String
    The current state of this export.
    timeCreated String
    The date and time the export 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.
    state string
    The current state of this export.
    timeCreated string
    The date and time the export 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.
    state str
    The current state of this export.
    time_created str
    The date and time the export 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.
    state String
    The current state of this export.
    timeCreated String
    The date and time the export was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    Look up Existing Export Resource

    Get an existing Export 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?: ExportState, opts?: CustomResourceOptions): Export
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            export_options: Optional[Sequence[_filestorage.ExportExportOptionArgs]] = None,
            export_set_id: Optional[str] = None,
            file_system_id: Optional[str] = None,
            is_idmap_groups_for_sys_auth: Optional[bool] = None,
            path: Optional[str] = None,
            state: Optional[str] = None,
            time_created: Optional[str] = None) -> Export
    func GetExport(ctx *Context, name string, id IDInput, state *ExportState, opts ...ResourceOption) (*Export, error)
    public static Export Get(string name, Input<string> id, ExportState? state, CustomResourceOptions? opts = null)
    public static Export get(String name, Output<String> id, ExportState 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:
    ExportOptions List<ExportExportOption>

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    ExportSetId string
    The OCID of this export's export set.
    FileSystemId string
    The OCID of this export's file system.
    IsIdmapGroupsForSysAuth bool
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    Path string

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

    ** 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 this export.
    TimeCreated string
    The date and time the export was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    ExportOptions []ExportExportOptionArgs

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    ExportSetId string
    The OCID of this export's export set.
    FileSystemId string
    The OCID of this export's file system.
    IsIdmapGroupsForSysAuth bool
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    Path string

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

    ** 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 this export.
    TimeCreated string
    The date and time the export was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    exportOptions List<ExportExportOption>

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    exportSetId String
    The OCID of this export's export set.
    fileSystemId String
    The OCID of this export's file system.
    isIdmapGroupsForSysAuth Boolean
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    path String

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

    ** 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 this export.
    timeCreated String
    The date and time the export was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    exportOptions ExportExportOption[]

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    exportSetId string
    The OCID of this export's export set.
    fileSystemId string
    The OCID of this export's file system.
    isIdmapGroupsForSysAuth boolean
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    path string

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

    ** 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 this export.
    timeCreated string
    The date and time the export was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    export_options Sequence[filestorage.ExportExportOptionArgs]

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    export_set_id str
    The OCID of this export's export set.
    file_system_id str
    The OCID of this export's file system.
    is_idmap_groups_for_sys_auth bool
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    path str

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

    ** 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 this export.
    time_created str
    The date and time the export was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z
    exportOptions List<Property Map>

    (Updatable) Export options for the new export. If left unspecified, defaults to: [ { "source" : "0.0.0.0/0", "requirePrivilegedSourcePort" : false, "access": "READ_WRITE", "identitySquash": "NONE", "anonymousUid": 65534, "anonymousGid": 65534, "isAnonymousAccessAllowed": false, "allowedAuth": ["SYS"] } ]

    Note: Mount targets do not have Internet-routable IP addresses. Therefore they will not be reachable from the Internet, even if an associated ClientOptions item has a source of 0.0.0.0/0.

    If set to the empty array then the export will not be visible to any clients.

    The export's exportOptions can be changed after creation using the UpdateExport operation.

    exportSetId String
    The OCID of this export's export set.
    fileSystemId String
    The OCID of this export's file system.
    isIdmapGroupsForSysAuth Boolean
    (Updatable) Whether or not the export should use ID mapping for Unix groups rather than the group list provided within an NFS request's RPC header. When this flag is true the Unix UID from the RPC header is used to retrieve the list of secondary groups from a the ID mapping subsystem. The primary GID is always taken from the RPC header. If ID mapping is not configured, incorrectly configured, unavailable, or cannot be used to determine a list of secondary groups then an empty secondary group list is used for authorization. If the number of groups exceeds the limit of 256 groups, the list retrieved from LDAP is truncated to the first 256 groups read.
    path String

    Path used to access the associated file system.

    Avoid entering confidential information.

    Example: /mediafiles

    ** 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 this export.
    timeCreated String
    The date and time the export was created, expressed in RFC 3339 timestamp format. Example: 2016-08-25T21:10:29.600Z

    Supporting Types

    ExportExportOption, ExportExportOptionArgs

    Source string

    (Updatable) Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.

    Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.

    Access string
    (Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_WRITE.
    AllowedAuths List<string>
    (Updatable) Array of allowed NFS authentication types.
    AnonymousGid string
    (Updatable) GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534.
    AnonymousUid string
    (Updatable) UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.
    IdentitySquash string
    (Updatable) Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT.
    IsAnonymousAccessAllowed bool
    (Updatable) Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.
    RequirePrivilegedSourcePort bool
    (Updatable) If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.
    Source string

    (Updatable) Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.

    Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.

    Access string
    (Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_WRITE.
    AllowedAuths []string
    (Updatable) Array of allowed NFS authentication types.
    AnonymousGid string
    (Updatable) GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534.
    AnonymousUid string
    (Updatable) UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.
    IdentitySquash string
    (Updatable) Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT.
    IsAnonymousAccessAllowed bool
    (Updatable) Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.
    RequirePrivilegedSourcePort bool
    (Updatable) If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.
    source String

    (Updatable) Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.

    Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.

    access String
    (Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_WRITE.
    allowedAuths List<String>
    (Updatable) Array of allowed NFS authentication types.
    anonymousGid String
    (Updatable) GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534.
    anonymousUid String
    (Updatable) UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.
    identitySquash String
    (Updatable) Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT.
    isAnonymousAccessAllowed Boolean
    (Updatable) Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.
    requirePrivilegedSourcePort Boolean
    (Updatable) If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.
    source string

    (Updatable) Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.

    Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.

    access string
    (Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_WRITE.
    allowedAuths string[]
    (Updatable) Array of allowed NFS authentication types.
    anonymousGid string
    (Updatable) GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534.
    anonymousUid string
    (Updatable) UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.
    identitySquash string
    (Updatable) Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT.
    isAnonymousAccessAllowed boolean
    (Updatable) Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.
    requirePrivilegedSourcePort boolean
    (Updatable) If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.
    source str

    (Updatable) Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.

    Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.

    access str
    (Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_WRITE.
    allowed_auths Sequence[str]
    (Updatable) Array of allowed NFS authentication types.
    anonymous_gid str
    (Updatable) GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534.
    anonymous_uid str
    (Updatable) UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.
    identity_squash str
    (Updatable) Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT.
    is_anonymous_access_allowed bool
    (Updatable) Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.
    require_privileged_source_port bool
    (Updatable) If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.
    source String

    (Updatable) Clients these options should apply to. Must be a either single IPv4 address or single IPv4 CIDR block.

    Note: Access will also be limited by any applicable VCN security rules and the ability to route IP packets to the mount target. Mount targets do not have Internet-routable IP addresses.

    access String
    (Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_WRITE.
    allowedAuths List<String>
    (Updatable) Array of allowed NFS authentication types.
    anonymousGid String
    (Updatable) GID value to remap to when squashing a client GID (see identitySquash for more details.) If unspecified defaults to 65534.
    anonymousUid String
    (Updatable) UID value to remap to when squashing a client UID (see identitySquash for more details.) If unspecified, defaults to 65534.
    identitySquash String
    (Updatable) Used when clients accessing the file system through this export have their UID and GID remapped to 'anonymousUid' and 'anonymousGid'. If ALL, all users and groups are remapped; if ROOT, only the root user and group (UID/GID 0) are remapped; if NONE, no remapping is done. If unspecified, defaults to ROOT.
    isAnonymousAccessAllowed Boolean
    (Updatable) Whether or not to enable anonymous access to the file system through this export in cases where a user isn't found in the LDAP server used for ID mapping. If true, and the user is not found in the LDAP directory, the operation uses the Squash UID and Squash GID.
    requirePrivilegedSourcePort Boolean
    (Updatable) If true, clients accessing the file system through this export must connect from a privileged source port. If unspecified, defaults to true.

    Import

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

    $ pulumi import oci:FileStorage/export:Export test_export "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