1. Pulumi Registry
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. FileStorage
  5. Export
oci logo
Oracle Cloud Infrastructure v0.12.0, Mar 17 23

oci.FileStorage.Export

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

using System.Collections.Generic;
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,
                AnonymousGid = @var.Export_export_options_anonymous_gid,
                AnonymousUid = @var.Export_export_options_anonymous_uid,
                IdentitySquash = @var.Export_export_options_identity_squash,
                RequirePrivilegedSourcePort = @var.Export_export_options_require_privileged_source_port,
            },
        },
    });

});

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),
					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),
					RequirePrivilegedSourcePort: pulumi.Any(_var.Export_export_options_require_privileged_source_port),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

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())
                .anonymousGid(var_.export_export_options_anonymous_gid())
                .anonymousUid(var_.export_export_options_anonymous_uid())
                .identitySquash(var_.export_export_options_identity_squash())
                .requirePrivilegedSourcePort(var_.export_export_options_require_privileged_source_port())
                .build())
            .build());

    }
}

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"],
        anonymous_gid=var["export_export_options_anonymous_gid"],
        anonymous_uid=var["export_export_options_anonymous_uid"],
        identity_squash=var["export_export_options_identity_squash"],
        require_privileged_source_port=var["export_export_options_require_privileged_source_port"],
    )])

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,
        anonymousGid: _var.export_export_options_anonymous_gid,
        anonymousUid: _var.export_export_options_anonymous_uid,
        identitySquash: _var.export_export_options_identity_squash,
        requirePrivilegedSourcePort: _var.export_export_options_require_privileged_source_port,
    }],
});

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}
          anonymousGid: ${var.export_export_options_anonymous_gid}
          anonymousUid: ${var.export_export_options_anonymous_uid}
          identitySquash: ${var.export_export_options_identity_squash}
          requirePrivilegedSourcePort: ${var.export_export_options_require_privileged_source_port}

Create Export Resource

new Export(name: string, args: ExportArgs, opts?: CustomResourceOptions);
@overload
def Export(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           export_options: Optional[Sequence[_filestorage.ExportExportOptionArgs]] = None,
           export_set_id: Optional[str] = None,
           file_system_id: Optional[str] = None,
           path: Optional[str] = None)
@overload
def Export(resource_name: str,
           args: ExportArgs,
           opts: Optional[ResourceOptions] = 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.
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.

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.

ExportOptions List<ExportExportOptionArgs>

(Updatable) Export options for the new export. If left unspecified, defaults to:

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.

ExportOptions []ExportExportOptionArgs

(Updatable) Export options for the new export. If left unspecified, defaults to:

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.

exportOptions List<ExportExportOptionArgs>

(Updatable) Export options for the new export. If left unspecified, defaults to:

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.

exportOptions ExportExportOptionArgs[]

(Updatable) Export options for the new export. If left unspecified, defaults to:

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.

export_options ExportExportOptionArgs]

(Updatable) Export options for the new export. If left unspecified, defaults to:

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.

exportOptions List<Property Map>

(Updatable) Export options for the new export. If left unspecified, defaults to:

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,
        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<ExportExportOptionArgs>

(Updatable) Export options for the new export. If left unspecified, defaults to:

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.

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:

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.

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

(Updatable) Export options for the new export. If left unspecified, defaults to:

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.

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:

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.

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 ExportExportOptionArgs]

(Updatable) Export options for the new export. If left unspecified, defaults to:

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.

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:

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.

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

Source string

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

Access string

(Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY.

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.

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.

Access string

(Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY.

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.

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.

access String

(Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY.

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.

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.

access string

(Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY.

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.

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.

access str

(Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY.

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.

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.

access String

(Updatable) Type of access to grant clients using the file system through this export. If unspecified defaults to READ_ONLY.

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.

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"

Package Details

Repository
oci pulumi/pulumi-oci
License
Apache-2.0
Notes

This Pulumi package is based on the oci Terraform Provider.