CfnFileSystemProps
- class aws_cdk.aws_fsx.CfnFileSystemProps(*, file_system_type, subnet_ids, backup_id=None, file_system_type_version=None, kms_key_id=None, lustre_configuration=None, ontap_configuration=None, open_zfs_configuration=None, security_group_ids=None, storage_capacity=None, storage_type=None, tags=None, windows_configuration=None)
Bases:
object
Properties for defining a
CfnFileSystem
.- Parameters:
file_system_type (
str
) – The type of Amazon FSx file system, which can beLUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.subnet_ids (
Sequence
[str
]) – Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAPMULTI_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 theWindowsConfiguration > PreferredSubnetID
orOntapConfiguration > 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 WindowsSINGLE_AZ_1
andSINGLE_AZ_2
and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet’s Availability Zone.backup_id (
Optional
[str
]) – The ID of the file system backup that you are using to create a file system. For more information, see CreateFileSystemFromBackup .file_system_type_version (
Optional
[str
]) – For FSx for Lustre file systems, sets the Lustre version for the file system that you’re creating. Valid values are2.10
,2.12
, and2.15
: -2.10
is supported by the Scratch and Persistent_1 Lustre deployment types. -2.12
is supported by all Lustre deployment types, except forPERSISTENT_2
with a metadata configuration mode. -2.15
is supported by all Lustre deployment types and is recommended for all new file systems. Default value is2.10
, except for the following deployments: - Default value is2.12
whenDeploymentType
is set toPERSISTENT_2
without a metadata configuration mode. - Default value is2.15
whenDeploymentType
is set toPERSISTENT_2
with a metadata configuration mode.kms_key_id (
Optional
[str
]) – The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: - Amazon FSx for LustrePERSISTENT_1
andPERSISTENT_2
deployment types only.SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service AWS KMS key for your account. - Amazon FSx for NetApp ONTAP - Amazon FSx for OpenZFS - Amazon FSx for Windows File Serverlustre_configuration (
Union
[IResolvable
,LustreConfigurationProperty
,Dict
[str
,Any
],None
]) – The Lustre configuration for the file system being created. .. epigraph:: The following parameters are not supported when creating Lustre file systems with a data repository association. -AutoImportPolicy
-ExportPath
-ImportedChunkSize
-ImportPath
ontap_configuration (
Union
[IResolvable
,OntapConfigurationProperty
,Dict
[str
,Any
],None
]) – The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.open_zfs_configuration (
Union
[IResolvable
,OpenZFSConfigurationProperty
,Dict
[str
,Any
],None
]) – The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.security_group_ids (
Optional
[Sequence
[str
]]) – A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn’t returned in later requests to describe the file system. .. epigraph:: You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.storage_capacity (
Union
[int
,float
,None
]) – Sets the storage capacity of the file system that you’re creating.StorageCapacity
is required if you are creating a new file system. It is not required if you are creating a file system by restoring a backup. FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set forStorageType
and the LustreDeploymentType
, as follows: - ForSCRATCH_2
,PERSISTENT_2
andPERSISTENT_1
deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. - ForPERSISTENT_1
HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. - ForSCRATCH_1
deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. FSx for ONTAP file systems - The amount of SSD storage capacity that you can configure depends on the value of theHAPairs
property. The minimum value is calculated as 1,024 GiB * HAPairs and the maximum is calculated as 524,288 GiB * HAPairs, up to a maximum amount of SSD storage capacity of 1,048,576 GiB (1 pebibyte). 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 forStorageType
as follows: - For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). - For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).storage_type (
Optional
[str
]) – Sets the storage type for the file system that you’re creating. Valid values areSSD
andHDD
. - Set toSSD
to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. - Set toHDD
to use hard disk drive storage. HDD is supported onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_1
Lustre file system deployment types. Default value isSSD
. 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 .tags (
Optional
[Sequence
[Union
[CfnTag
,Dict
[str
,Any
]]]]) – The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide .windows_configuration (
Union
[IResolvable
,WindowsConfigurationProperty
,Dict
[str
,Any
],None
]) – The configuration object for the Microsoft Windows file system you are creating. This value is required ifFileSystemType
is set toWINDOWS
.
- See:
http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. from aws_cdk import aws_fsx as fsx cfn_file_system_props = fsx.CfnFileSystemProps( file_system_type="fileSystemType", subnet_ids=["subnetIds"], # the properties below are optional backup_id="backupId", file_system_type_version="fileSystemTypeVersion", kms_key_id="kmsKeyId", lustre_configuration=fsx.CfnFileSystem.LustreConfigurationProperty( auto_import_policy="autoImportPolicy", automatic_backup_retention_days=123, copy_tags_to_backups=False, daily_automatic_backup_start_time="dailyAutomaticBackupStartTime", data_compression_type="dataCompressionType", deployment_type="deploymentType", drive_cache_type="driveCacheType", export_path="exportPath", imported_file_chunk_size=123, import_path="importPath", metadata_configuration=fsx.CfnFileSystem.MetadataConfigurationProperty( iops=123, mode="mode" ), per_unit_storage_throughput=123, weekly_maintenance_start_time="weeklyMaintenanceStartTime" ), ontap_configuration=fsx.CfnFileSystem.OntapConfigurationProperty( deployment_type="deploymentType", # the properties below are optional automatic_backup_retention_days=123, daily_automatic_backup_start_time="dailyAutomaticBackupStartTime", disk_iops_configuration=fsx.CfnFileSystem.DiskIopsConfigurationProperty( iops=123, mode="mode" ), endpoint_ip_address_range="endpointIpAddressRange", fsx_admin_password="fsxAdminPassword", ha_pairs=123, preferred_subnet_id="preferredSubnetId", route_table_ids=["routeTableIds"], throughput_capacity=123, throughput_capacity_per_ha_pair=123, weekly_maintenance_start_time="weeklyMaintenanceStartTime" ), open_zfs_configuration=fsx.CfnFileSystem.OpenZFSConfigurationProperty( deployment_type="deploymentType", # the properties below are optional automatic_backup_retention_days=123, copy_tags_to_backups=False, copy_tags_to_volumes=False, daily_automatic_backup_start_time="dailyAutomaticBackupStartTime", disk_iops_configuration=fsx.CfnFileSystem.DiskIopsConfigurationProperty( iops=123, mode="mode" ), endpoint_ip_address_range="endpointIpAddressRange", options=["options"], preferred_subnet_id="preferredSubnetId", root_volume_configuration=fsx.CfnFileSystem.RootVolumeConfigurationProperty( copy_tags_to_snapshots=False, data_compression_type="dataCompressionType", nfs_exports=[fsx.CfnFileSystem.NfsExportsProperty( client_configurations=[fsx.CfnFileSystem.ClientConfigurationsProperty( clients="clients", options=["options"] )] )], read_only=False, record_size_ki_b=123, user_and_group_quotas=[fsx.CfnFileSystem.UserAndGroupQuotasProperty( id=123, storage_capacity_quota_gi_b=123, type="type" )] ), route_table_ids=["routeTableIds"], throughput_capacity=123, weekly_maintenance_start_time="weeklyMaintenanceStartTime" ), security_group_ids=["securityGroupIds"], storage_capacity=123, storage_type="storageType", tags=[CfnTag( key="key", value="value" )], windows_configuration=fsx.CfnFileSystem.WindowsConfigurationProperty( throughput_capacity=123, # the properties below are optional active_directory_id="activeDirectoryId", aliases=["aliases"], audit_log_configuration=fsx.CfnFileSystem.AuditLogConfigurationProperty( file_access_audit_log_level="fileAccessAuditLogLevel", file_share_access_audit_log_level="fileShareAccessAuditLogLevel", # the properties below are optional audit_log_destination="auditLogDestination" ), automatic_backup_retention_days=123, copy_tags_to_backups=False, daily_automatic_backup_start_time="dailyAutomaticBackupStartTime", deployment_type="deploymentType", disk_iops_configuration=fsx.CfnFileSystem.DiskIopsConfigurationProperty( iops=123, mode="mode" ), preferred_subnet_id="preferredSubnetId", self_managed_active_directory_configuration=fsx.CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty( dns_ips=["dnsIps"], domain_name="domainName", file_system_administrators_group="fileSystemAdministratorsGroup", organizational_unit_distinguished_name="organizationalUnitDistinguishedName", password="password", user_name="userName" ), weekly_maintenance_start_time="weeklyMaintenanceStartTime" ) )
Attributes
- backup_id
The ID of the file system backup that you are using to create a file system.
For more information, see CreateFileSystemFromBackup .
- file_system_type
The type of Amazon FSx file system, which can be
LUSTRE
,WINDOWS
,ONTAP
, orOPENZFS
.
- file_system_type_version
For FSx for Lustre file systems, sets the Lustre version for the file system that you’re creating.
Valid values are
2.10
,2.12
, and2.15
:2.10
is supported by the Scratch and Persistent_1 Lustre deployment types.2.12
is supported by all Lustre deployment types, except forPERSISTENT_2
with a metadata configuration mode.2.15
is supported by all Lustre deployment types and is recommended for all new file systems.
Default value is
2.10
, except for the following deployments:Default value is
2.12
whenDeploymentType
is set toPERSISTENT_2
without a metadata configuration mode.Default value is
2.15
whenDeploymentType
is set toPERSISTENT_2
with a metadata configuration mode.
- kms_key_id
The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data.
Used as follows with Amazon FSx file system types:
Amazon FSx for Lustre
PERSISTENT_1
andPERSISTENT_2
deployment types only.
SCRATCH_1
andSCRATCH_2
types are encrypted using the Amazon FSx service AWS KMS key for your account.Amazon FSx for NetApp ONTAP
Amazon FSx for OpenZFS
Amazon FSx for Windows File Server
- lustre_configuration
The Lustre configuration for the file system being created.
The following parameters are not supported when creating Lustre file systems with a data repository association.
AutoImportPolicy
ExportPath
ImportedChunkSize
ImportPath
- ontap_configuration
The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.
- open_zfs_configuration
The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.
- security_group_ids
A list of IDs specifying the security groups to apply to all network interfaces created for file system access.
This list isn’t returned in later requests to describe the file system. .. epigraph:
You must specify a security group if you are creating a Multi-AZ FSx for ONTAP file system in a VPC subnet that has been shared with you.
- storage_capacity
Sets the storage capacity of the file system that you’re creating.
StorageCapacity
is required if you are creating a new file system. It is not required if you are creating a file system by restoring a backup.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 LustreDeploymentType
, as follows:For
SCRATCH_2
,PERSISTENT_2
andPERSISTENT_1
deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.For
PERSISTENT_1
HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.For
SCRATCH_1
deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.
FSx for ONTAP file systems - The amount of SSD storage capacity that you can configure depends on the value of the
HAPairs
property. The minimum value is calculated as 1,024 GiB * HAPairs and the maximum is calculated as 524,288 GiB * HAPairs, up to a maximum amount of SSD storage capacity of 1,048,576 GiB (1 pebibyte).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:For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).
For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).
- storage_type
Sets the storage type for the file system that you’re creating. Valid values are
SSD
andHDD
.Set to
SSD
to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.Set to
HDD
to use hard disk drive storage. HDD is supported onSINGLE_AZ_2
andMULTI_AZ_1
Windows file system deployment types, and onPERSISTENT_1
Lustre file system deployment types.
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 .
- subnet_ids
Specifies the IDs of the subnets that the file system will be accessible from.
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 theWindowsConfiguration > PreferredSubnetID
orOntapConfiguration > 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
andSINGLE_AZ_2
and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet’s Availability Zone.
- tags
The tags to associate with the file system.
For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide .
- windows_configuration
The configuration object for the Microsoft Windows file system you are creating.
This value is required if
FileSystemType
is set toWINDOWS
.