Class CfnFileSystem

The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnFileSystem

Implements

IInspectable

IFileSystemRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.AddResourceDependency(CfnResource, string)

CfnResource.ApplyCrossStackReferenceStrength(ReferenceStrength)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.CfnPropertyName(string)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.RemoveResourceDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.FSx

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnFileSystem : CfnResource, IInspectable, IFileSystemRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnFileSystem Inherits CfnResource Implements IInspectable, IFileSystemRef, IConstruct, IDependable, IEnvironmentAware, 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",
                     DataReadCacheConfiguration = new DataReadCacheConfigurationProperty {
                         SizeGiB = 123,
                         SizingMode = "sizingMode"
                     },
                     DeploymentType = "deploymentType",
                     DriveCacheType = "driveCacheType",
                     EfaEnabled = false,
                     ExportPath = "exportPath",
                     ImportedFileChunkSize = 123,
                     ImportPath = "importPath",
                     LogConfiguration = new LogConfigurationProperty {
                         Level = "level",

                         // the properties below are optional
                         Destination = "destination"
                     },
                     MetadataConfiguration = new MetadataConfigurationProperty {
                         Iops = 123,
                         Mode = "mode"
                     },
                     PerUnitStorageThroughput = 123,
                     ThroughputCapacity = 123,
                     WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
                 },
                 NetworkType = "networkType",
                 OntapConfiguration = new OntapConfigurationProperty {
                     DeploymentType = "deploymentType",

                     // the properties below are optional
                     AutomaticBackupRetentionDays = 123,
                     DailyAutomaticBackupStartTime = "dailyAutomaticBackupStartTime",
                     DiskIopsConfiguration = new DiskIopsConfigurationProperty {
                         Iops = 123,
                         Mode = "mode"
                     },
                     EndpointIpAddressRange = "endpointIpAddressRange",
                     EndpointIpv6AddressRange = "endpointIpv6AddressRange",
                     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",
                     EndpointIpv6AddressRange = "endpointIpv6AddressRange",
                     Options = new [] { "options" },
                     PreferredSubnetId = "preferredSubnetId",
                     ReadCacheConfiguration = new ReadCacheConfigurationProperty {
                         SizeGiB = 123,
                         SizingMode = "sizingMode"
                     },
                     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"
                     },
                     FsrmConfiguration = new FsrmConfigurationProperty {
                         FsrmServiceEnabled = false,

                         // the properties below are optional
                         EventLogDestination = "eventLogDestination"
                     },
                     PreferredSubnetId = "preferredSubnetId",
                     SelfManagedActiveDirectoryConfiguration = new SelfManagedActiveDirectoryConfigurationProperty {
                         DnsIps = new [] { "dnsIps" },
                         DomainJoinServiceAccountSecret = "domainJoinServiceAccountSecret",
                         DomainName = "domainName",
                         FileSystemAdministratorsGroup = "fileSystemAdministratorsGroup",
                         OrganizationalUnitDistinguishedName = "organizationalUnitDistinguishedName",
                         Password = "password",
                         UserName = "userName"
                     },
                     WeeklyMaintenanceStartTime = "weeklyMaintenanceStartTime"
                 }
             });

Synopsis

Constructors

CfnFileSystem(Construct, string, ICfnFileSystemProps)

Create a new AWS::FSx::FileSystem.

Properties

AttrDnsName	Returns the FSx for Windows file system's DNSName.
AttrId	The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.
AttrLustreMountName	Returns the Lustre file system's LustreMountName .
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	The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.
CfnPropertyNames	The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.
FileSystemRef	A reference to a FileSystem resource.
FileSystemType	The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS .
FileSystemTypeVersion	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 ) key used to encrypt Amazon FSx file system data.
LustreConfiguration	The Lustre configuration for the file system being created.
NetworkType	The network type of the file system.
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 class 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.
IsCfnFileSystem(object)	Checks whether the given object is a CfnFileSystem.
RenderProperties(IDictionary<string, object>)	The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.

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 string

Construct identifier for this resource (unique in its scope).

props ICfnFileSystemProps

Resource properties.

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

Properties

AttrDnsName

Returns the FSx for Windows file system's DNSName.

public virtual string AttrDnsName { get; }

Property Value

string

Remarks

Example: amznfsxp1honlek.corp.example.com

CloudformationAttribute: DNSName

AttrId

The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.

public virtual string AttrId { get; }

Property Value

string

Remarks

CloudformationAttribute: Id

AttrLustreMountName

Returns the Lustre file system's LustreMountName .

public virtual string AttrLustreMountName { get; }

Property Value

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

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

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

string

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

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

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

CfnProperties

The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

IDictionary<string, object>

Overrides

CfnResource.CfnProperties

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

CfnPropertyNames

The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.

protected override IDictionary<string, string> CfnPropertyNames { get; }

Property Value

IDictionary<string, string>

Overrides

CfnResource.CfnPropertyNames

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

FileSystemRef

A reference to a FileSystem resource.

public virtual IFileSystemReference FileSystemRef { get; }

Property Value

IFileSystemReference

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

FileSystemType

The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS .

public virtual string FileSystemType { get; set; }

Property Value

string

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

FileSystemTypeVersion

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

string

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

KmsKeyId

The ID of the AWS Key Management Service ( AWS ) key used to encrypt Amazon FSx file system data.

public virtual string? KmsKeyId { get; set; }

Property Value

string

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

LustreConfiguration

The Lustre configuration for the file system being created.

public virtual object? LustreConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnFileSystem.ILustreConfigurationProperty

NetworkType

The network type of the file system.

public virtual string? NetworkType { get; set; }

Property Value

string

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

OntapConfiguration

The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

public virtual object? OntapConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnFileSystem.IOntapConfigurationProperty

OpenZfsConfiguration

The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

public virtual object? OpenZfsConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnFileSystem.IOpenZFSConfigurationProperty

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

string[]

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

StorageCapacity

Sets the storage capacity of the file system that you're creating.

public virtual double? StorageCapacity { get; set; }

Property Value

double?

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

StorageType

Sets the storage class for the file system that you're creating.

public virtual string? StorageType { get; set; }

Property Value

string

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

SubnetIds

Specifies the IDs of the subnets that the file system will be accessible from.

public virtual string[] SubnetIds { get; set; }

Property Value

string[]

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

Tags

Tag Manager which manages the tags for this resource.

public virtual TagManager Tags { get; }

Property Value

TagManager

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

TagsRaw

The tags to associate with the file system.

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

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

WindowsConfiguration

The configuration object for the Microsoft Windows file system you are creating.

public virtual object? WindowsConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnFileSystem.IWindowsConfigurationProperty

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.

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

IsCfnFileSystem(object)

Checks whether the given object is a CfnFileSystem.

public static bool IsCfnFileSystem(object x)

Parameters

x object

Returns

bool

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

RenderProperties(IDictionary<string, object>)

The AWS::FSx::FileSystem resource is an Amazon FSx resource type that specifies an Amazon FSx file system.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

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

Implements

IInspectable

IFileSystemRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable