Class CfnFileSystem
A CloudFormation AWS::FSx::FileSystem
.
Inherited Members
Namespace: Amazon.CDK.AWS.FSx
Assembly: Amazon.CDK.AWS.FSx.dll
Syntax (csharp)
public class CfnFileSystem : CfnResource, IConstruct, IDependable, IInspectable
Syntax (vb)
Public Class CfnFileSystem
Inherits CfnResource
Implements IConstruct, IDependable, IInspectable
Remarks
The AWS::FSx::FileSystem
resource is an Amazon FSx resource type that specifies an Amazon FSx file system. You can create any of the following supported file system types:
CloudformationResource: AWS::FSx::FileSystem
Link: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.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 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",
PreferredSubnetId = "preferredSubnetId",
RouteTableIds = new [] { "routeTableIds" },
ThroughputCapacity = 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"
},
Options = new [] { "options" },
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"
} }
},
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",
PreferredSubnetId = "preferredSubnetId",
SelfManagedActiveDirectoryConfiguration = new SelfManagedActiveDirectoryConfigurationProperty {
DnsIps = new [] { "dnsIps" },
DomainName = "domainName",
FileSystemAdministratorsGroup = "fileSystemAdministratorsGroup",
OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName",
Password = "password",
UserName = "userName"
},
WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
}
});
Synopsis
Constructors
CfnFileSystem(Construct, String, ICfnFileSystemProps) | Create a new |
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 |
Properties
AttrDnsName | Returns the FSx for Windows file system's DNSName. |
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. Valid values are |
SubnetIds | Specifies the IDs of the subnets that the file system will be accessible from. |
Tags | An array of key-value pairs to apply to this resource. |
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(Construct, String, ICfnFileSystemProps)
Create a new AWS::FSx::FileSystem
.
public CfnFileSystem(Construct scope, string id, ICfnFileSystemProps props)
Parameters
- scope Construct
- scope in which this resource is defined.
- id System.String
- scoped id of the resource.
- props ICfnFileSystemProps
- resource properties.
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
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
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
Remarks
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
Remarks
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
Remarks
Valid values are 2.10
and 2.12
:
Default value = 2.10
, except when DeploymentType
is set to PERSISTENT_2
, then the default is 2.12
.
If you set <code>FileSystemTypeVersion</code> to <code>2.10</code> for a <code>PERSISTENT_2</code> Lustre deployment type, the <code>CreateFileSystem</code> operation fails.
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
Remarks
Used as follows with Amazon FSx file system types:
SCRATCH_1
and SCRATCH_2
types are encrypted using the Amazon FSx service AWS KMS key for your account.
LustreConfiguration
The Lustre configuration for the file system being created.
public virtual object LustreConfiguration { get; set; }
Property Value
System.Object
Remarks
The following parameters are not supported for file systems with a data repository association.
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
Remarks
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
Remarks
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[]
Remarks
This list isn't returned in later requests to describe the file system.
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>
Remarks
StorageCapacity
is required if you are creating a new file system.
FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType
and the Lustre DeploymentType
, as follows:
FSx for ONTAP file systems - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).
FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). If you are creating a file system from a backup, you can specify a storage capacity equal to or greater than the original file system's storage capacity.
FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType
as follows:
StorageType
Sets the storage type for the file system that you're creating. Valid values are SSD
and HDD
.
public virtual string StorageType { get; set; }
Property Value
System.String
Remarks
Default value is SSD
. For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide .
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[]
Remarks
For Windows and ONTAP MULTI_AZ_1
deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID
or OntapConfiguration > PreferredSubnetID
properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide .
For Windows SINGLE_AZ_1
and SINGLE_AZ_2
and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet's Availability Zone.
Tags
An array of key-value pairs to apply to this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
For more information, see Tag .
WindowsConfiguration
The configuration object for the Microsoft Windows file system you are creating.
public virtual object WindowsConfiguration { get; set; }
Property Value
System.Object
Remarks
This value is required if FileSystemType
is set to WINDOWS
.
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>