Class CfnVolume
Creates an FSx for ONTAP or Amazon FSx for OpenZFS storage volume.
Inherited Members
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnVolume : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnVolume
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-volume.html
CloudformationResource: AWS::FSx::Volume
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 cfnVolume = new CfnVolume(this, "MyCfnVolume", 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
CfnVolume(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnVolume(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnVolume(Construct, String, ICfnVolumeProps) |
Properties
AttrResourceArn | Returns the volume's Amazon Resource Name (ARN). |
AttrUuid | Returns the volume's universally unique identifier (UUID). |
AttrVolumeId | Returns the volume's ID. |
BackupId | Specifies the ID of the volume backup to use to create a new volume. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
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 | Tag Manager which manages the tags for this resource. |
TagsRaw | An array of key-value pairs to apply to this resource. |
VolumeType | The type of the volume. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnVolume(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnVolume(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnVolume(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnVolume(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnVolume(Construct, String, ICfnVolumeProps)
public CfnVolume(Construct scope, string id, ICfnVolumeProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnVolumeProps
Resource properties.
Properties
AttrResourceArn
Returns the volume's Amazon Resource Name (ARN).
public virtual string AttrResourceArn { get; }
Property Value
System.String
Remarks
Example: arn:aws:fsx:us-east-2:111122223333:volume/fs-0123456789abcdef9/fsvol-01234567891112223
CloudformationAttribute: ResourceARN
AttrUuid
Returns the volume's universally unique identifier (UUID).
public virtual string AttrUuid { get; }
Property Value
System.String
Remarks
Example: abcd0123-cd45-ef67-11aa-1111aaaa23bc
CloudformationAttribute: UUID
AttrVolumeId
Returns the volume's ID.
public virtual string AttrVolumeId { get; }
Property Value
System.String
Remarks
Example: fsvol-0123456789abcdefa
CloudformationAttribute: VolumeId
BackupId
Specifies the ID of the volume backup to use to create a new volume.
public virtual string BackupId { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Name
The name of the volume.
public virtual string Name { get; set; }
Property Value
System.String
OntapConfiguration
The configuration of an Amazon FSx for NetApp ONTAP volume.
public virtual object OntapConfiguration { get; set; }
Property Value
System.Object
OpenZfsConfiguration
The configuration of an Amazon FSx for OpenZFS volume.
public virtual object OpenZfsConfiguration { get; set; }
Property Value
System.Object
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
An array of key-value pairs to apply to this resource.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
VolumeType
The type of the volume.
public virtual string VolumeType { get; set; }
Property Value
System.String
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>