Class Share

Use this resource to configure a share.

Example Usage

using Pulumi;
using OpenStack = Pulumi.OpenStack;

class MyStack : Stack
{
public MyStack()
{
    var network1 = new OpenStack.Networking.Network("network1", new OpenStack.Networking.NetworkArgs
    {
        AdminStateUp = "true",
    });
    var subnet1 = new OpenStack.Networking.Subnet("subnet1", new OpenStack.Networking.SubnetArgs
    {
        Cidr = "192.168.199.0/24",
        IpVersion = 4,
        NetworkId = network1.Id,
    });
    var sharenetwork1 = new OpenStack.SharedFileSystem.ShareNetwork("sharenetwork1", new OpenStack.SharedFileSystem.ShareNetworkArgs
    {
        Description = "test share network with security services",
        NeutronNetId = network1.Id,
        NeutronSubnetId = subnet1.Id,
    });
    var share1 = new OpenStack.SharedFileSystem.Share("share1", new OpenStack.SharedFileSystem.ShareArgs
    {
        Description = "test share description",
        ShareNetworkId = sharenetwork1.Id,
        ShareProto = "NFS",
        Size = 1,
    });
}

}
Inheritance
System.Object
Resource
CustomResource
Share
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.OpenStack.SharedFileSystem
Assembly: Pulumi.OpenStack.dll
Syntax
public class Share : CustomResource

Constructors

View Source

Share(String, ShareArgs, CustomResourceOptions)

Create a Share resource with the given unique name, arguments, and options.

Declaration
public Share(string name, ShareArgs args, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resource
ShareArgs args

The arguments used to populate this resource's properties
CustomResourceOptions options

A bag of options that control this resource's behavior

Properties

View Source

AllMetadata

The map of metadata, assigned on the share, which has been explicitly and implicitly added.

Declaration
public Output<ImmutableDictionary<string, object>> AllMetadata { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

AvailabilityZone

The share availability zone. Changing this creates a new share.

Declaration
public Output<string> AvailabilityZone { get; }
Property Value
Type Description
Output<System.String>
View Source

Description

The human-readable description for the share. Changing this updates the description of the existing share.

Declaration
public Output<string> Description { get; }
Property Value
Type Description
Output<System.String>
View Source

ExportLocations

A list of export locations. For example, when a share server has more than one network interface, it can have multiple export locations.

Declaration
public Output<ImmutableArray<ShareExportLocation>> ExportLocations { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableArray<ShareExportLocation>>
View Source

HasReplicas

Indicates whether a share has replicas or not.

Declaration
public Output<bool> HasReplicas { get; }
Property Value
Type Description
Output<System.Boolean>
View Source

Host

The share host name.

Declaration
public Output<string> Host { get; }
Property Value
Type Description
Output<System.String>
View Source

IsPublic

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.

Declaration
public Output<bool?> IsPublic { get; }
Property Value
Type Description
Output<System.Nullable<System.Boolean>>
View Source

Metadata

One or more metadata key and value pairs as a dictionary of strings.

Declaration
public Output<ImmutableDictionary<string, object>> Metadata { get; }
Property Value
Type Description
Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.Object>>
View Source

Name

The name of the share. Changing this updates the name of the existing share.

Declaration
public Output<string> Name { get; }
Property Value
Type Description
Output<System.String>
View Source

ProjectId

The owner of the Share.

Declaration
public Output<string> ProjectId { get; }
Property Value
Type Description
Output<System.String>
View Source

Region

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.

Declaration
public Output<string> Region { get; }
Property Value
Type Description
Output<System.String>
View Source

ReplicationType

The share replication type.

Declaration
public Output<string> ReplicationType { get; }
Property Value
Type Description
Output<System.String>
View Source

ShareNetworkId

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.

Declaration
public Output<string> ShareNetworkId { get; }
Property Value
Type Description
Output<System.String>
View Source

ShareProto

The share protocol - can either be NFS, CIFS, CEPHFS, GLUSTERFS, HDFS or MAPRFS. Changing this creates a new share.

Declaration
public Output<string> ShareProto { get; }
Property Value
Type Description
Output<System.String>
View Source

ShareServerId

The UUID of the share server.

Declaration
public Output<string> ShareServerId { get; }
Property Value
Type Description
Output<System.String>
View Source

ShareType

The share type name. If you omit this parameter, the default share type is used.

Declaration
public Output<string> ShareType { get; }
Property Value
Type Description
Output<System.String>
View Source

Size

The share size, in GBs. The requested share size cannot be greater than the allowed GB quota. Changing this resizes the existing share.

Declaration
public Output<int> Size { get; }
Property Value
Type Description
Output<System.Int32>
View Source

SnapshotId

The UUID of the share's base snapshot. Changing this creates a new share.

Declaration
public Output<string> SnapshotId { get; }
Property Value
Type Description
Output<System.String>

Methods

View Source

Get(String, Input<String>, ShareState, CustomResourceOptions)

Get an existing Share resource's state with the given name, ID, and optional extra properties used to qualify the lookup.

Declaration
public static Share Get(string name, Input<string> id, ShareState state = null, CustomResourceOptions options = null)
Parameters
Type Name Description
System.String name

The unique name of the resulting resource.
Input<System.String> id

The unique provider ID of the resource to lookup.
ShareState state

Any extra arguments used during the lookup.
CustomResourceOptions options

A bag of options that control this resource's behavior
Returns
Type Description
Share