Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Openstack Provider
  3. API Docs
  4. sharedfilesystem
  5. Share
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-openstack

openstack.sharedfilesystem.Share

Explore with Pulumi AI

openstack logo
OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
pulumi/pulumi-openstack

    Use this resource to configure a share.

    Example Usage

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

const network1 = new openstack.networking.Network("network_1", {
    name: "network_1",
    adminStateUp: true,
});
const subnet1 = new openstack.networking.Subnet("subnet_1", {
    name: "subnet_1",
    cidr: "192.168.199.0/24",
    ipVersion: 4,
    networkId: network1.id,
});
const sharenetwork1 = new openstack.sharedfilesystem.ShareNetwork("sharenetwork_1", {
    name: "test_sharenetwork",
    description: "test share network with security services",
    neutronNetId: network1.id,
    neutronSubnetId: subnet1.id,
});
const share1 = new openstack.sharedfilesystem.Share("share_1", {
    name: "nfs_share",
    description: "test share description",
    shareProto: "NFS",
    size: 1,
    shareNetworkId: sharenetwork1.id,
});

    import pulumi
import pulumi_openstack as openstack

network1 = openstack.networking.Network("network_1",
    name="network_1",
    admin_state_up=True)
subnet1 = openstack.networking.Subnet("subnet_1",
    name="subnet_1",
    cidr="192.168.199.0/24",
    ip_version=4,
    network_id=network1.id)
sharenetwork1 = openstack.sharedfilesystem.ShareNetwork("sharenetwork_1",
    name="test_sharenetwork",
    description="test share network with security services",
    neutron_net_id=network1.id,
    neutron_subnet_id=subnet1.id)
share1 = openstack.sharedfilesystem.Share("share_1",
    name="nfs_share",
    description="test share description",
    share_proto="NFS",
    size=1,
    share_network_id=sharenetwork1.id)

    package main

import (
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/networking"
	"github.com/pulumi/pulumi-openstack/sdk/v5/go/openstack/sharedfilesystem"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		network1, err := networking.NewNetwork(ctx, "network_1", &networking.NetworkArgs{
			Name:         pulumi.String("network_1"),
			AdminStateUp: pulumi.Bool(true),
		})
		if err != nil {
			return err
		}
		subnet1, err := networking.NewSubnet(ctx, "subnet_1", &networking.SubnetArgs{
			Name:      pulumi.String("subnet_1"),
			Cidr:      pulumi.String("192.168.199.0/24"),
			IpVersion: pulumi.Int(4),
			NetworkId: network1.ID(),
		})
		if err != nil {
			return err
		}
		sharenetwork1, err := sharedfilesystem.NewShareNetwork(ctx, "sharenetwork_1", &sharedfilesystem.ShareNetworkArgs{
			Name:            pulumi.String("test_sharenetwork"),
			Description:     pulumi.String("test share network with security services"),
			NeutronNetId:    network1.ID(),
			NeutronSubnetId: subnet1.ID(),
		})
		if err != nil {
			return err
		}
		_, err = sharedfilesystem.NewShare(ctx, "share_1", &sharedfilesystem.ShareArgs{
			Name:           pulumi.String("nfs_share"),
			Description:    pulumi.String("test share description"),
			ShareProto:     pulumi.String("NFS"),
			Size:           pulumi.Int(1),
			ShareNetworkId: sharenetwork1.ID(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using OpenStack = Pulumi.OpenStack;

return await Deployment.RunAsync(() => 
{
    var network1 = new OpenStack.Networking.Network("network_1", new()
    {
        Name = "network_1",
        AdminStateUp = true,
    });

    var subnet1 = new OpenStack.Networking.Subnet("subnet_1", new()
    {
        Name = "subnet_1",
        Cidr = "192.168.199.0/24",
        IpVersion = 4,
        NetworkId = network1.Id,
    });

    var sharenetwork1 = new OpenStack.SharedFileSystem.ShareNetwork("sharenetwork_1", new()
    {
        Name = "test_sharenetwork",
        Description = "test share network with security services",
        NeutronNetId = network1.Id,
        NeutronSubnetId = subnet1.Id,
    });

    var share1 = new OpenStack.SharedFileSystem.Share("share_1", new()
    {
        Name = "nfs_share",
        Description = "test share description",
        ShareProto = "NFS",
        Size = 1,
        ShareNetworkId = sharenetwork1.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.openstack.networking.Network;
import com.pulumi.openstack.networking.NetworkArgs;
import com.pulumi.openstack.networking.Subnet;
import com.pulumi.openstack.networking.SubnetArgs;
import com.pulumi.openstack.sharedfilesystem.ShareNetwork;
import com.pulumi.openstack.sharedfilesystem.ShareNetworkArgs;
import com.pulumi.openstack.sharedfilesystem.Share;
import com.pulumi.openstack.sharedfilesystem.ShareArgs;
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 network1 = new Network("network1", NetworkArgs.builder()
            .name("network_1")
            .adminStateUp("true")
            .build());

        var subnet1 = new Subnet("subnet1", SubnetArgs.builder()
            .name("subnet_1")
            .cidr("192.168.199.0/24")
            .ipVersion(4)
            .networkId(network1.id())
            .build());

        var sharenetwork1 = new ShareNetwork("sharenetwork1", ShareNetworkArgs.builder()
            .name("test_sharenetwork")
            .description("test share network with security services")
            .neutronNetId(network1.id())
            .neutronSubnetId(subnet1.id())
            .build());

        var share1 = new Share("share1", ShareArgs.builder()
            .name("nfs_share")
            .description("test share description")
            .shareProto("NFS")
            .size(1)
            .shareNetworkId(sharenetwork1.id())
            .build());

    }
}

    resources:
  network1:
    type: openstack:networking:Network
    name: network_1
    properties:
      name: network_1
      adminStateUp: 'true'
  subnet1:
    type: openstack:networking:Subnet
    name: subnet_1
    properties:
      name: subnet_1
      cidr: 192.168.199.0/24
      ipVersion: 4
      networkId: ${network1.id}
  sharenetwork1:
    type: openstack:sharedfilesystem:ShareNetwork
    name: sharenetwork_1
    properties:
      name: test_sharenetwork
      description: test share network with security services
      neutronNetId: ${network1.id}
      neutronSubnetId: ${subnet1.id}
  share1:
    type: openstack:sharedfilesystem:Share
    name: share_1
    properties:
      name: nfs_share
      description: test share description
      shareProto: NFS
      size: 1
      shareNetworkId: ${sharenetwork1.id}

    Create Share Resource

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

    Constructor syntax

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

@overload
def Share(resource_name: str,
          opts: Optional[ResourceOptions] = None,
          share_proto: Optional[str] = None,
          size: Optional[int] = None,
          availability_zone: Optional[str] = None,
          description: Optional[str] = None,
          is_public: Optional[bool] = None,
          metadata: Optional[Mapping[str, str]] = None,
          name: Optional[str] = None,
          region: Optional[str] = None,
          share_network_id: Optional[str] = None,
          share_type: Optional[str] = None,
          snapshot_id: Optional[str] = None)
    func NewShare(ctx *Context, name string, args ShareArgs, opts ...ResourceOption) (*Share, error)
    public Share(string name, ShareArgs args, CustomResourceOptions? opts = null)
    public Share(String name, ShareArgs args)
public Share(String name, ShareArgs args, CustomResourceOptions options)

    type: openstack:sharedfilesystem:Share
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 ShareArgs
    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 ShareArgs
    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 ShareArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ShareArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ShareArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

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

    var shareResource = new OpenStack.SharedFileSystem.Share("shareResource", new()
{
    ShareProto = "string",
    Size = 0,
    AvailabilityZone = "string",
    Description = "string",
    IsPublic = false,
    Metadata = 
    {
        { "string", "string" },
    },
    Name = "string",
    Region = "string",
    ShareNetworkId = "string",
    ShareType = "string",
    SnapshotId = "string",
});

    example, err := sharedfilesystem.NewShare(ctx, "shareResource", &sharedfilesystem.ShareArgs{
	ShareProto:       pulumi.String("string"),
	Size:             pulumi.Int(0),
	AvailabilityZone: pulumi.String("string"),
	Description:      pulumi.String("string"),
	IsPublic:         pulumi.Bool(false),
	Metadata: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Name:           pulumi.String("string"),
	Region:         pulumi.String("string"),
	ShareNetworkId: pulumi.String("string"),
	ShareType:      pulumi.String("string"),
	SnapshotId:     pulumi.String("string"),
})

    var shareResource = new Share("shareResource", ShareArgs.builder()
    .shareProto("string")
    .size(0)
    .availabilityZone("string")
    .description("string")
    .isPublic(false)
    .metadata(Map.of("string", "string"))
    .name("string")
    .region("string")
    .shareNetworkId("string")
    .shareType("string")
    .snapshotId("string")
    .build());

    share_resource = openstack.sharedfilesystem.Share("shareResource",
    share_proto="string",
    size=0,
    availability_zone="string",
    description="string",
    is_public=False,
    metadata={
        "string": "string",
    },
    name="string",
    region="string",
    share_network_id="string",
    share_type="string",
    snapshot_id="string")

    const shareResource = new openstack.sharedfilesystem.Share("shareResource", {
    shareProto: "string",
    size: 0,
    availabilityZone: "string",
    description: "string",
    isPublic: false,
    metadata: {
        string: "string",
    },
    name: "string",
    region: "string",
    shareNetworkId: "string",
    shareType: "string",
    snapshotId: "string",
});

    type: openstack:sharedfilesystem:Share
properties:
    availabilityZone: string
    description: string
    isPublic: false
    metadata:
        string: string
    name: string
    region: string
    shareNetworkId: string
    shareProto: string
    shareType: string
    size: 0
    snapshotId: string

    Share Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Share resource accepts the following input properties:

    ShareProto string
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    Size int
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    AvailabilityZone string
    The share availability zone. Changing this creates a new share.
    Description string
    The human-readable description for the share. Changing this updates the description of the existing share.
    IsPublic bool
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    Metadata Dictionary<string, string>
    One or more metadata key and value pairs as a dictionary of strings.
    Name string
    The name of the share. Changing this updates the name of the existing share.
    Region string
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    ShareNetworkId string
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    ShareType string
    The share type name. If you omit this parameter, the default share type is used.
    SnapshotId string
    The UUID of the share's base snapshot. Changing this creates a new share.
    ShareProto string
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    Size int
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    AvailabilityZone string
    The share availability zone. Changing this creates a new share.
    Description string
    The human-readable description for the share. Changing this updates the description of the existing share.
    IsPublic bool
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    Metadata map[string]string
    One or more metadata key and value pairs as a dictionary of strings.
    Name string
    The name of the share. Changing this updates the name of the existing share.
    Region string
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    ShareNetworkId string
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    ShareType string
    The share type name. If you omit this parameter, the default share type is used.
    SnapshotId string
    The UUID of the share's base snapshot. Changing this creates a new share.
    shareProto String
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    size Integer
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    availabilityZone String
    The share availability zone. Changing this creates a new share.
    description String
    The human-readable description for the share. Changing this updates the description of the existing share.
    isPublic Boolean
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    metadata Map<String,String>
    One or more metadata key and value pairs as a dictionary of strings.
    name String
    The name of the share. Changing this updates the name of the existing share.
    region String
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    shareNetworkId String
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    shareType String
    The share type name. If you omit this parameter, the default share type is used.
    snapshotId String
    The UUID of the share's base snapshot. Changing this creates a new share.
    shareProto string
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    size number
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    availabilityZone string
    The share availability zone. Changing this creates a new share.
    description string
    The human-readable description for the share. Changing this updates the description of the existing share.
    isPublic boolean
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    metadata {[key: string]: string}
    One or more metadata key and value pairs as a dictionary of strings.
    name string
    The name of the share. Changing this updates the name of the existing share.
    region string
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    shareNetworkId string
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    shareType string
    The share type name. If you omit this parameter, the default share type is used.
    snapshotId string
    The UUID of the share's base snapshot. Changing this creates a new share.
    share_proto str
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    size int
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    availability_zone str
    The share availability zone. Changing this creates a new share.
    description str
    The human-readable description for the share. Changing this updates the description of the existing share.
    is_public bool
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    metadata Mapping[str, str]
    One or more metadata key and value pairs as a dictionary of strings.
    name str
    The name of the share. Changing this updates the name of the existing share.
    region str
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    share_network_id str
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    share_type str
    The share type name. If you omit this parameter, the default share type is used.
    snapshot_id str
    The UUID of the share's base snapshot. Changing this creates a new share.
    shareProto String
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    size Number
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    availabilityZone String
    The share availability zone. Changing this creates a new share.
    description String
    The human-readable description for the share. Changing this updates the description of the existing share.
    isPublic Boolean
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    metadata Map<String>
    One or more metadata key and value pairs as a dictionary of strings.
    name String
    The name of the share. Changing this updates the name of the existing share.
    region String
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    shareNetworkId String
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    shareType String
    The share type name. If you omit this parameter, the default share type is used.
    snapshotId String
    The UUID of the share's base snapshot. Changing this creates a new share.

    Outputs

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

    AllMetadata Dictionary<string, string>
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    ExportLocations List<Pulumi.OpenStack.SharedFileSystem.Outputs.ShareExportLocation>
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    HasReplicas bool
    Indicates whether a share has replicas or not.
    Host string
    The share host name.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    The owner of the Share.
    ReplicationType string
    The share replication type.
    ShareServerId string
    The UUID of the share server.
    AllMetadata map[string]string
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    ExportLocations []ShareExportLocation
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    HasReplicas bool
    Indicates whether a share has replicas or not.
    Host string
    The share host name.
    Id string
    The provider-assigned unique ID for this managed resource.
    ProjectId string
    The owner of the Share.
    ReplicationType string
    The share replication type.
    ShareServerId string
    The UUID of the share server.
    allMetadata Map<String,String>
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    exportLocations List<ShareExportLocation>
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    hasReplicas Boolean
    Indicates whether a share has replicas or not.
    host String
    The share host name.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    The owner of the Share.
    replicationType String
    The share replication type.
    shareServerId String
    The UUID of the share server.
    allMetadata {[key: string]: string}
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    exportLocations ShareExportLocation[]
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    hasReplicas boolean
    Indicates whether a share has replicas or not.
    host string
    The share host name.
    id string
    The provider-assigned unique ID for this managed resource.
    projectId string
    The owner of the Share.
    replicationType string
    The share replication type.
    shareServerId string
    The UUID of the share server.
    all_metadata Mapping[str, str]
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    export_locations Sequence[ShareExportLocation]
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    has_replicas bool
    Indicates whether a share has replicas or not.
    host str
    The share host name.
    id str
    The provider-assigned unique ID for this managed resource.
    project_id str
    The owner of the Share.
    replication_type str
    The share replication type.
    share_server_id str
    The UUID of the share server.
    allMetadata Map<String>
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    exportLocations List<Property Map>
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    hasReplicas Boolean
    Indicates whether a share has replicas or not.
    host String
    The share host name.
    id String
    The provider-assigned unique ID for this managed resource.
    projectId String
    The owner of the Share.
    replicationType String
    The share replication type.
    shareServerId String
    The UUID of the share server.

    Look up Existing Share Resource

    Get an existing Share 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?: ShareState, opts?: CustomResourceOptions): Share
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        all_metadata: Optional[Mapping[str, str]] = None,
        availability_zone: Optional[str] = None,
        description: Optional[str] = None,
        export_locations: Optional[Sequence[ShareExportLocationArgs]] = None,
        has_replicas: Optional[bool] = None,
        host: Optional[str] = None,
        is_public: Optional[bool] = None,
        metadata: Optional[Mapping[str, str]] = None,
        name: Optional[str] = None,
        project_id: Optional[str] = None,
        region: Optional[str] = None,
        replication_type: Optional[str] = None,
        share_network_id: Optional[str] = None,
        share_proto: Optional[str] = None,
        share_server_id: Optional[str] = None,
        share_type: Optional[str] = None,
        size: Optional[int] = None,
        snapshot_id: Optional[str] = None) -> Share
    func GetShare(ctx *Context, name string, id IDInput, state *ShareState, opts ...ResourceOption) (*Share, error)
    public static Share Get(string name, Input<string> id, ShareState? state, CustomResourceOptions? opts = null)
    public static Share get(String name, Output<String> id, ShareState state, CustomResourceOptions options)
    resources:  _:    type: openstack:sharedfilesystem:Share    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AllMetadata Dictionary<string, string>
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    AvailabilityZone string
    The share availability zone. Changing this creates a new share.
    Description string
    The human-readable description for the share. Changing this updates the description of the existing share.
    ExportLocations List<Pulumi.OpenStack.SharedFileSystem.Inputs.ShareExportLocation>
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    HasReplicas bool
    Indicates whether a share has replicas or not.
    Host string
    The share host name.
    IsPublic bool
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    Metadata Dictionary<string, string>
    One or more metadata key and value pairs as a dictionary of strings.
    Name string
    The name of the share. Changing this updates the name of the existing share.
    ProjectId string
    The owner of the Share.
    Region string
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    ReplicationType string
    The share replication type.
    ShareNetworkId string
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    ShareProto string
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    ShareServerId string
    The UUID of the share server.
    ShareType string
    The share type name. If you omit this parameter, the default share type is used.
    Size int
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    SnapshotId string
    The UUID of the share's base snapshot. Changing this creates a new share.
    AllMetadata map[string]string
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    AvailabilityZone string
    The share availability zone. Changing this creates a new share.
    Description string
    The human-readable description for the share. Changing this updates the description of the existing share.
    ExportLocations []ShareExportLocationArgs
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    HasReplicas bool
    Indicates whether a share has replicas or not.
    Host string
    The share host name.
    IsPublic bool
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    Metadata map[string]string
    One or more metadata key and value pairs as a dictionary of strings.
    Name string
    The name of the share. Changing this updates the name of the existing share.
    ProjectId string
    The owner of the Share.
    Region string
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    ReplicationType string
    The share replication type.
    ShareNetworkId string
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    ShareProto string
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    ShareServerId string
    The UUID of the share server.
    ShareType string
    The share type name. If you omit this parameter, the default share type is used.
    Size int
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    SnapshotId string
    The UUID of the share's base snapshot. Changing this creates a new share.
    allMetadata Map<String,String>
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    availabilityZone String
    The share availability zone. Changing this creates a new share.
    description String
    The human-readable description for the share. Changing this updates the description of the existing share.
    exportLocations List<ShareExportLocation>
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    hasReplicas Boolean
    Indicates whether a share has replicas or not.
    host String
    The share host name.
    isPublic Boolean
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    metadata Map<String,String>
    One or more metadata key and value pairs as a dictionary of strings.
    name String
    The name of the share. Changing this updates the name of the existing share.
    projectId String
    The owner of the Share.
    region String
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    replicationType String
    The share replication type.
    shareNetworkId String
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    shareProto String
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    shareServerId String
    The UUID of the share server.
    shareType String
    The share type name. If you omit this parameter, the default share type is used.
    size Integer
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    snapshotId String
    The UUID of the share's base snapshot. Changing this creates a new share.
    allMetadata {[key: string]: string}
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    availabilityZone string
    The share availability zone. Changing this creates a new share.
    description string
    The human-readable description for the share. Changing this updates the description of the existing share.
    exportLocations ShareExportLocation[]
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    hasReplicas boolean
    Indicates whether a share has replicas or not.
    host string
    The share host name.
    isPublic boolean
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    metadata {[key: string]: string}
    One or more metadata key and value pairs as a dictionary of strings.
    name string
    The name of the share. Changing this updates the name of the existing share.
    projectId string
    The owner of the Share.
    region string
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    replicationType string
    The share replication type.
    shareNetworkId string
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    shareProto string
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    shareServerId string
    The UUID of the share server.
    shareType string
    The share type name. If you omit this parameter, the default share type is used.
    size number
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    snapshotId string
    The UUID of the share's base snapshot. Changing this creates a new share.
    all_metadata Mapping[str, str]
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    availability_zone str
    The share availability zone. Changing this creates a new share.
    description str
    The human-readable description for the share. Changing this updates the description of the existing share.
    export_locations Sequence[ShareExportLocationArgs]
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    has_replicas bool
    Indicates whether a share has replicas or not.
    host str
    The share host name.
    is_public bool
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    metadata Mapping[str, str]
    One or more metadata key and value pairs as a dictionary of strings.
    name str
    The name of the share. Changing this updates the name of the existing share.
    project_id str
    The owner of the Share.
    region str
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    replication_type str
    The share replication type.
    share_network_id str
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    share_proto str
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    share_server_id str
    The UUID of the share server.
    share_type str
    The share type name. If you omit this parameter, the default share type is used.
    size int
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    snapshot_id str
    The UUID of the share's base snapshot. Changing this creates a new share.
    allMetadata Map<String>
    The map of metadata, assigned on the share, which has been explicitly and implicitly added.
    availabilityZone String
    The share availability zone. Changing this creates a new share.
    description String
    The human-readable description for the share. Changing this updates the description of the existing share.
    exportLocations List<Property Map>
    A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.
    hasReplicas Boolean
    Indicates whether a share has replicas or not.
    host String
    The share host name.
    isPublic Boolean
    The level of visibility for the share. Set to true to make share public. Set to false to make it private. Default value is false. Changing this updates the existing share.
    metadata Map<String>
    One or more metadata key and value pairs as a dictionary of strings.
    name String
    The name of the share. Changing this updates the name of the existing share.
    projectId String
    The owner of the Share.
    region String
    The region in which to obtain the V2 Shared File System client. A Shared File System client is needed to create a share. Changing this creates a new share.
    replicationType String
    The share replication type.
    shareNetworkId String
    The UUID of a share network where the share server exists or will be created. If share_network_id is not set and you provide a snapshot_id, the share_network_id value from the snapshot is used. Changing this creates a new share.
    shareProto String
    The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.
    shareServerId String
    The UUID of the share server.
    shareType String
    The share type name. If you omit this parameter, the default share type is used.
    size Number
    The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.
    snapshotId String
    The UUID of the share's base snapshot. Changing this creates a new share.

    Supporting Types

    ShareExportLocation, ShareExportLocationArgs

    Path string
    Preferred string
    Path string
    Preferred string
    path String
    preferred String
    path string
    preferred string
    path String
    preferred String

    Import

    This resource can be imported by specifying the ID of the share:

    $ pulumi import openstack:sharedfilesystem/share:Share share_1 id

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

    Package Details

    Repository
    OpenStack pulumi/pulumi-openstack
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the openstack Terraform Provider.
    openstack logo
    OpenStack v5.0.3 published on Wednesday, Feb 12, 2025 by Pulumi
    pulumi/pulumi-openstack