Class CfnVolumeProps
Properties for defining a CfnVolume
.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnVolumeProps : Object, ICfnVolumeProps
Syntax (vb)
Public Class CfnVolumeProps
Inherits Object
Implements ICfnVolumeProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.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 cfnVolumeProps = new CfnVolumeProps {
Name = "name",
// the properties below are optional
BackupId = "backupId",
OntapConfiguration = new OntapConfigurationProperty {
StorageVirtualMachineId = "storageVirtualMachineId",
// the properties below are optional
AggregateConfiguration = new AggregateConfigurationProperty {
Aggregates = new [] { "aggregates" },
ConstituentsPerAggregate = 123
},
CopyTagsToBackups = "copyTagsToBackups",
JunctionPath = "junctionPath",
OntapVolumeType = "ontapVolumeType",
SecurityStyle = "securityStyle",
SizeInBytes = "sizeInBytes",
SizeInMegabytes = "sizeInMegabytes",
SnaplockConfiguration = new SnaplockConfigurationProperty {
SnaplockType = "snaplockType",
// the properties below are optional
AuditLogVolume = "auditLogVolume",
AutocommitPeriod = new AutocommitPeriodProperty {
Type = "type",
// the properties below are optional
Value = 123
},
PrivilegedDelete = "privilegedDelete",
RetentionPeriod = new SnaplockRetentionPeriodProperty {
DefaultRetention = new RetentionPeriodProperty {
Type = "type",
// the properties below are optional
Value = 123
},
MaximumRetention = new RetentionPeriodProperty {
Type = "type",
// the properties below are optional
Value = 123
},
MinimumRetention = new RetentionPeriodProperty {
Type = "type",
// the properties below are optional
Value = 123
}
},
VolumeAppendModeEnabled = "volumeAppendModeEnabled"
},
SnapshotPolicy = "snapshotPolicy",
StorageEfficiencyEnabled = "storageEfficiencyEnabled",
TieringPolicy = new TieringPolicyProperty {
CoolingPeriod = 123,
Name = "name"
},
VolumeStyle = "volumeStyle"
},
OpenZfsConfiguration = new OpenZFSConfigurationProperty {
ParentVolumeId = "parentVolumeId",
// the properties below are optional
CopyTagsToSnapshots = false,
DataCompressionType = "dataCompressionType",
NfsExports = new [] { new NfsExportsProperty {
ClientConfigurations = new [] { new ClientConfigurationsProperty {
Clients = "clients",
Options = new [] { "options" }
} }
} },
Options = new [] { "options" },
OriginSnapshot = new OriginSnapshotProperty {
CopyStrategy = "copyStrategy",
SnapshotArn = "snapshotArn"
},
ReadOnly = false,
RecordSizeKiB = 123,
StorageCapacityQuotaGiB = 123,
StorageCapacityReservationGiB = 123,
UserAndGroupQuotas = new [] { new UserAndGroupQuotasProperty {
Id = 123,
StorageCapacityQuotaGiB = 123,
Type = "type"
} }
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
VolumeType = "volumeType"
};
Synopsis
Constructors
CfnVolumeProps() |
Properties
BackupId | Specifies the ID of the volume backup to use to create a new volume. |
Name | The name of the volume. |
OntapConfiguration | The configuration of an Amazon FSx for NetApp ONTAP volume. |
OpenZfsConfiguration | The configuration of an Amazon FSx for OpenZFS volume. |
Tags | An array of key-value pairs to apply to this resource. |
VolumeType | The type of the volume. |
Constructors
CfnVolumeProps()
public CfnVolumeProps()
Properties
BackupId
Specifies the ID of the volume backup to use to create a new volume.
public string BackupId { get; set; }
Property Value
System.String
Remarks
Name
The name of the volume.
public string Name { get; set; }
Property Value
System.String
Remarks
OntapConfiguration
The configuration of an Amazon FSx for NetApp ONTAP volume.
public object OntapConfiguration { get; set; }
Property Value
System.Object
Remarks
OpenZfsConfiguration
The configuration of an Amazon FSx for OpenZFS volume.
public object OpenZfsConfiguration { get; set; }
Property Value
System.Object
Remarks
Tags
An array of key-value pairs to apply to this resource.
public ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Remarks
For more information, see Tag .
VolumeType
The type of the volume.
public string VolumeType { get; set; }
Property Value
System.String