Class CfnFileSystem.RootVolumeConfigurationProperty

The configuration of an Amazon FSx for OpenZFS root volume.

Inheritance

System.Object

CfnFileSystem.RootVolumeConfigurationProperty

Implements

CfnFileSystem.IRootVolumeConfigurationProperty

Namespace: Amazon.CDK.AWS.FSx

Assembly: Amazon.CDK.AWS.FSx.dll

Syntax (csharp)

public class RootVolumeConfigurationProperty : Object, CfnFileSystem.IRootVolumeConfigurationProperty

Syntax (vb)

Public Class RootVolumeConfigurationProperty
    Inherits Object
    Implements CfnFileSystem.IRootVolumeConfigurationProperty

Remarks

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.FSx;

var rootVolumeConfigurationProperty = new RootVolumeConfigurationProperty {
    CopyTagsToSnapshots = false,
    DataCompressionType = "dataCompressionType",
    NfsExports = new [] { new NfsExportsProperty {
        ClientConfigurations = new [] { new ClientConfigurationsProperty {
            Clients = "clients",
            Options = new [] { "options" }
        } }
    } },
    ReadOnly = false,
    RecordSizeKiB = 123,
    UserAndGroupQuotas = new [] { new UserAndGroupQuotasProperty {
        Id = 123,
        StorageCapacityQuotaGiB = 123,
        Type = "type"
    } }
};

Synopsis

Constructors

RootVolumeConfigurationProperty()

Properties

CopyTagsToSnapshots	A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume.
DataCompressionType	Specifies the method used to compress the data on the volume. The compression type is `NONE` by default.
NfsExports	The configuration object for mounting a file system.
ReadOnly	A Boolean value indicating whether the volume is read-only.
RecordSizeKiB	Specifies the record size of an OpenZFS root volume, in kibibytes (KiB).
UserAndGroupQuotas	An object specifying how much storage users or groups can use on the volume.

Constructors

RootVolumeConfigurationProperty()

public RootVolumeConfigurationProperty()

Properties

CopyTagsToSnapshots

A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume.

public object CopyTagsToSnapshots { get; set; }

Property Value

System.Object

Remarks

This value defaults to false . If it's set to true , all tags for the volume are copied to snapshots where the user doesn't specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration-copytagstosnapshots

DataCompressionType

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

public string DataCompressionType { get; set; }

Property Value

System.String

Remarks

NfsExports

The configuration object for mounting a file system.

public object NfsExports { get; set; }

Property Value

System.Object

Remarks

ReadOnly

A Boolean value indicating whether the volume is read-only.

public object ReadOnly { get; set; }

Property Value

System.Object

Remarks

Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

RecordSizeKiB

Specifies the record size of an OpenZFS root volume, in kibibytes (KiB).

public Nullable<double> RecordSizeKiB { get; set; }

Property Value

System.Nullable<System.Double>

Remarks

Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide .

UserAndGroupQuotas

An object specifying how much storage users or groups can use on the volume.

public object UserAndGroupQuotas { get; set; }