Class CfnFileSystem
The AWS::FSx::FileSystem
resource is an Amazon FSx resource type that specifies an Amazon FSx file system.
Inherited Members
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnFileSystem : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnFileSystem
Inherits CfnResource
Implements IInspectable, ITaggable
Remarks
You can create any of the following supported file system types:
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html
CloudformationResource: AWS::FSx::FileSystem
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 cfnFileSystem = new CfnFileSystem(this, "MyCfnFileSystem", new CfnFileSystemProps {
FileSystemType = "fileSystemType",
SubnetIds = new [] { "subnetIds" },
// the properties below are optional
BackupId = "backupId",
FileSystemTypeVersion = "fileSystemTypeVersion",
KmsKeyId = "kmsKeyId",
LustreConfiguration = new LustreConfigurationProperty {
AutoImportPolicy = "autoImportPolicy",
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = false,
DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
DataCompressionType = "dataCompressionType",
DeploymentType = "deploymentType",
DriveCacheType = "driveCacheType",
ExportPath = "exportPath",
ImportedFileChunkSize = 123,
ImportPath = "importPath",
PerUnitStorageThroughput = 123,
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
},
OntapConfiguration = new OntapConfigurationProperty {
DeploymentType = "deploymentType",
// the properties below are optional
AutomaticBackupRetentionDays = 123,
DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
DiskIopsConfiguration = new DiskIopsConfigurationProperty {
Iops = 123,
Mode = "mode"
},
EndpointIpAddressRange = "endpointIpAddressRange",
FsxAdminPassword = "fsxAdminPassword",
HaPairs = 123,
PreferredSubnetId = "preferredSubnetId",
RouteTableIds = new [] { "routeTableIds" },
ThroughputCapacity = 123,
ThroughputCapacityPerHaPair = 123,
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
},
OpenZfsConfiguration = new OpenZFSConfigurationProperty {
DeploymentType = "deploymentType",
// the properties below are optional
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = false,
CopyTagsToVolumes = false,
DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
DiskIopsConfiguration = new DiskIopsConfigurationProperty {
Iops = 123,
Mode = "mode"
},
EndpointIpAddressRange = "endpointIpAddressRange",
Options = new [] { "options" },
PreferredSubnetId = "preferredSubnetId",
RootVolumeConfiguration = 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"
} }
},
RouteTableIds = new [] { "routeTableIds" },
ThroughputCapacity = 123,
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
},
SecurityGroupIds = new [] { "securityGroupIds" },
StorageCapacity = 123,
StorageType = "storageType",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} },
WindowsConfiguration = new WindowsConfigurationProperty {
ThroughputCapacity = 123,
// the properties below are optional
ActiveDirectoryId = "activeDirectoryId",
Aliases = new [] { "aliases" },
AuditLogConfiguration = new AuditLogConfigurationProperty {
FileAccessAuditLogLevel = "fileAccessAuditLogLevel",
FileShareAccessAuditLogLevel = "fileShareAccessAuditLogLevel",
// the properties below are optional
AuditLogDestination = "auditLogDestination"
},
AutomaticBackupRetentionDays = 123,
CopyTagsToBackups = false,
DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
DeploymentType = "deploymentType",
DiskIopsConfiguration = new DiskIopsConfigurationProperty {
Iops = 123,
Mode = "mode"
},
PreferredSubnetId = "preferredSubnetId",
SelfManagedActiveDirectoryConfiguration = new SelfManagedActiveDirectoryConfigurationProperty {
DnsIps = new [] { "dnsIps" },
DomainName = "domainName",
FileSystemAdministratorsGroup = "fileSystemAdministratorsGroup",
OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName",
Password = "password",
UserName = "userName"
},
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
}
});
Synopsis
Constructors
CfnFileSystem(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnFileSystem(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnFileSystem(Construct, String, ICfnFileSystemProps) |
Properties
AttrDnsName | Returns the FSx for Windows file system's DNSName. |
AttrId | |
AttrLustreMountName | Returns the Lustre file system's |
AttrResourceArn | Returns the Amazon Resource Name (ARN) for the Amazon FSx file system. |
AttrRootVolumeId | Returns the root volume ID of the FSx for OpenZFS file system. |
BackupId | The ID of the file system backup that you are using to create a file system. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
FileSystemType | The type of Amazon FSx file system, which can be |
FileSystemTypeVersion | (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating. |
KmsKeyId | The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data. |
LustreConfiguration | The Lustre configuration for the file system being created. |
OntapConfiguration | The ONTAP configuration properties of the FSx for ONTAP file system that you are creating. |
OpenZfsConfiguration | The Amazon FSx for OpenZFS configuration properties for the file system that you are creating. |
SecurityGroupIds | A list of IDs specifying the security groups to apply to all network interfaces created for file system access. |
StorageCapacity | Sets the storage capacity of the file system that you're creating. |
StorageType | Sets the storage type for the file system that you're creating. |
SubnetIds | Specifies the IDs of the subnets that the file system will be accessible from. |
Tags | Tag Manager which manages the tags for this resource. |
TagsRaw | The tags to associate with the file system. |
WindowsConfiguration | The configuration object for the Microsoft Windows file system you are creating. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnFileSystem(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnFileSystem(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnFileSystem(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnFileSystem(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnFileSystem(Construct, String, ICfnFileSystemProps)
public CfnFileSystem(Construct scope, string id, ICfnFileSystemProps 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 ICfnFileSystemProps
Resource properties.
Properties
AttrDnsName
Returns the FSx for Windows file system's DNSName.
public virtual string AttrDnsName { get; }
Property Value
System.String
Remarks
Example: amznfsxp1honlek.corp.example.com
CloudformationAttribute: DNSName
AttrId
public virtual string AttrId { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Id
AttrLustreMountName
Returns the Lustre file system's LustreMountName
.
public virtual string AttrLustreMountName { get; }
Property Value
System.String
Remarks
Example for SCRATCH_1
deployment types: This value is always fsx
.
Example for SCRATCH_2
and PERSISTENT
deployment types: 2p3fhbmv
CloudformationAttribute: LustreMountName
AttrResourceArn
Returns the Amazon Resource Name (ARN) for the Amazon FSx file system.
public virtual string AttrResourceArn { get; }
Property Value
System.String
Remarks
Example: arn:aws:fsx:us-east-2:111122223333:file-system/fs-0123abcd56789ef0a
CloudformationAttribute: ResourceARN
AttrRootVolumeId
Returns the root volume ID of the FSx for OpenZFS file system.
public virtual string AttrRootVolumeId { get; }
Property Value
System.String
Remarks
Example: fsvol-0123456789abcdefa
CloudformationAttribute: RootVolumeId
BackupId
The ID of the file system backup that you are using to create a file system.
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
FileSystemType
The type of Amazon FSx file system, which can be LUSTRE
, WINDOWS
, ONTAP
, or OPENZFS
.
public virtual string FileSystemType { get; set; }
Property Value
System.String
FileSystemTypeVersion
(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you're creating.
public virtual string FileSystemTypeVersion { get; set; }
Property Value
System.String
KmsKeyId
The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data.
public virtual string KmsKeyId { get; set; }
Property Value
System.String
LustreConfiguration
The Lustre configuration for the file system being created.
public virtual object LustreConfiguration { get; set; }
Property Value
System.Object
OntapConfiguration
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
public virtual object OntapConfiguration { get; set; }
Property Value
System.Object
OpenZfsConfiguration
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
public virtual object OpenZfsConfiguration { get; set; }
Property Value
System.Object
SecurityGroupIds
A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
public virtual string[] SecurityGroupIds { get; set; }
Property Value
System.String[]
StorageCapacity
Sets the storage capacity of the file system that you're creating.
public virtual Nullable<double> StorageCapacity { get; set; }
Property Value
System.Nullable<System.Double>
StorageType
Sets the storage type for the file system that you're creating.
public virtual string StorageType { get; set; }
Property Value
System.String
Remarks
Valid values are SSD
and HDD
.
SubnetIds
Specifies the IDs of the subnets that the file system will be accessible from.
public virtual string[] SubnetIds { get; set; }
Property Value
System.String[]
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
TagsRaw
The tags to associate with the file system.
public virtual ICfnTag[] TagsRaw { get; set; }
Property Value
ICfnTag[]
WindowsConfiguration
The configuration object for the Microsoft Windows file system you are creating.
public virtual object WindowsConfiguration { get; set; }
Property Value
System.Object
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>