CfnFileSystemPropsMixin

class aws_cdk.mixins_preview.aws_fsx.mixins.CfnFileSystemPropsMixin(props, *, strategy=None)

Bases: Mixin

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:

Amazon FSx for Lustre
Amazon FSx for NetApp ONTAP
FSx for OpenZFS
Amazon FSx for Windows File Server

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html
CloudformationResource:: AWS::FSx::FileSystem
Mixin:: true
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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_fsx import mixins as fsx_mixins

cfn_file_system_props_mixin = fsx_mixins.CfnFileSystemPropsMixin(fsx_mixins.CfnFileSystemMixinProps(
    backup_id="backupId",
    file_system_type="fileSystemType",
    file_system_type_version="fileSystemTypeVersion",
    kms_key_id="kmsKeyId",
    lustre_configuration=fsx_mixins.CfnFileSystemPropsMixin.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",
        data_read_cache_configuration=fsx_mixins.CfnFileSystemPropsMixin.DataReadCacheConfigurationProperty(
            size_gi_b=123,
            sizing_mode="sizingMode"
        ),
        deployment_type="deploymentType",
        drive_cache_type="driveCacheType",
        efa_enabled=False,
        export_path="exportPath",
        imported_file_chunk_size=123,
        import_path="importPath",
        metadata_configuration=fsx_mixins.CfnFileSystemPropsMixin.MetadataConfigurationProperty(
            iops=123,
            mode="mode"
        ),
        per_unit_storage_throughput=123,
        throughput_capacity=123,
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    ),
    network_type="networkType",
    ontap_configuration=fsx_mixins.CfnFileSystemPropsMixin.OntapConfigurationProperty(
        automatic_backup_retention_days=123,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        deployment_type="deploymentType",
        disk_iops_configuration=fsx_mixins.CfnFileSystemPropsMixin.DiskIopsConfigurationProperty(
            iops=123,
            mode="mode"
        ),
        endpoint_ip_address_range="endpointIpAddressRange",
        endpoint_ipv6_address_range="endpointIpv6AddressRange",
        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_mixins.CfnFileSystemPropsMixin.OpenZFSConfigurationProperty(
        automatic_backup_retention_days=123,
        copy_tags_to_backups=False,
        copy_tags_to_volumes=False,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        deployment_type="deploymentType",
        disk_iops_configuration=fsx_mixins.CfnFileSystemPropsMixin.DiskIopsConfigurationProperty(
            iops=123,
            mode="mode"
        ),
        endpoint_ip_address_range="endpointIpAddressRange",
        endpoint_ipv6_address_range="endpointIpv6AddressRange",
        options=["options"],
        preferred_subnet_id="preferredSubnetId",
        read_cache_configuration=fsx_mixins.CfnFileSystemPropsMixin.ReadCacheConfigurationProperty(
            size_gi_b=123,
            sizing_mode="sizingMode"
        ),
        root_volume_configuration=fsx_mixins.CfnFileSystemPropsMixin.RootVolumeConfigurationProperty(
            copy_tags_to_snapshots=False,
            data_compression_type="dataCompressionType",
            nfs_exports=[fsx_mixins.CfnFileSystemPropsMixin.NfsExportsProperty(
                client_configurations=[fsx_mixins.CfnFileSystemPropsMixin.ClientConfigurationsProperty(
                    clients="clients",
                    options=["options"]
                )]
            )],
            read_only=False,
            record_size_ki_b=123,
            user_and_group_quotas=[fsx_mixins.CfnFileSystemPropsMixin.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",
    subnet_ids=["subnetIds"],
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    windows_configuration=fsx_mixins.CfnFileSystemPropsMixin.WindowsConfigurationProperty(
        active_directory_id="activeDirectoryId",
        aliases=["aliases"],
        audit_log_configuration=fsx_mixins.CfnFileSystemPropsMixin.AuditLogConfigurationProperty(
            audit_log_destination="auditLogDestination",
            file_access_audit_log_level="fileAccessAuditLogLevel",
            file_share_access_audit_log_level="fileShareAccessAuditLogLevel"
        ),
        automatic_backup_retention_days=123,
        copy_tags_to_backups=False,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        deployment_type="deploymentType",
        disk_iops_configuration=fsx_mixins.CfnFileSystemPropsMixin.DiskIopsConfigurationProperty(
            iops=123,
            mode="mode"
        ),
        preferred_subnet_id="preferredSubnetId",
        self_managed_active_directory_configuration=fsx_mixins.CfnFileSystemPropsMixin.SelfManagedActiveDirectoryConfigurationProperty(
            dns_ips=["dnsIps"],
            domain_join_service_account_secret="domainJoinServiceAccountSecret",
            domain_name="domainName",
            file_system_administrators_group="fileSystemAdministratorsGroup",
            organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
            password="password",
            user_name="userName"
        ),
        throughput_capacity=123,
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    )
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::FSx::FileSystem.

Parameters:

props (Union[CfnFileSystemMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['backupId', 'fileSystemType', 'fileSystemTypeVersion', 'kmsKeyId', 'lustreConfiguration', 'networkType', 'ontapConfiguration', 'openZfsConfiguration', 'securityGroupIds', 'storageCapacity', 'storageType', 'subnetIds', 'tags', 'windowsConfiguration']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AuditLogConfigurationProperty

class CfnFileSystemPropsMixin.AuditLogConfigurationProperty(*, audit_log_destination=None, file_access_audit_log_level=None, file_share_access_audit_log_level=None)

Bases: object

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

Parameters:

audit_log_destination (Optional[str]) – The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN. The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix. The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same AWS partition, AWS Region , and AWS account as your Amazon FSx file system.
file_access_audit_log_level (Optional[str]) – Sets which attempt type is logged by Amazon FSx for file and folder accesses. - SUCCESS_ONLY - only successful attempts to access files or folders are logged. - FAILURE_ONLY - only failed attempts to access files or folders are logged. - SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged. - DISABLED - access auditing of files and folders is turned off.
file_share_access_audit_log_level (Optional[str]) – Sets which attempt type is logged by Amazon FSx for file share accesses. - SUCCESS_ONLY - only successful attempts to access file shares are logged. - FAILURE_ONLY - only failed attempts to access file shares are logged. - SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged. - DISABLED - access auditing of file shares is turned off.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-auditlogconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

audit_log_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.AuditLogConfigurationProperty(
    audit_log_destination="auditLogDestination",
    file_access_audit_log_level="fileAccessAuditLogLevel",
    file_share_access_audit_log_level="fileShareAccessAuditLogLevel"
)

Attributes

audit_log_destination

The Amazon Resource Name (ARN) for the destination of the audit logs.

The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN.

The name of the Amazon CloudWatch Logs log group must begin with the /aws/fsx prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the aws-fsx prefix.

The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same AWS partition, AWS Region , and AWS account as your Amazon FSx file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-auditlogconfiguration.html#cfn-fsx-filesystem-auditlogconfiguration-auditlogdestination

file_access_audit_log_level

Sets which attempt type is logged by Amazon FSx for file and folder accesses.

SUCCESS_ONLY - only successful attempts to access files or folders are logged.
FAILURE_ONLY - only failed attempts to access files or folders are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access files or folders are logged.
DISABLED - access auditing of files and folders is turned off.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-auditlogconfiguration.html#cfn-fsx-filesystem-auditlogconfiguration-fileaccessauditloglevel

file_share_access_audit_log_level

Sets which attempt type is logged by Amazon FSx for file share accesses.

SUCCESS_ONLY - only successful attempts to access file shares are logged.
FAILURE_ONLY - only failed attempts to access file shares are logged.
SUCCESS_AND_FAILURE - both successful attempts and failed attempts to access file shares are logged.
DISABLED - access auditing of file shares is turned off.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-auditlogconfiguration.html#cfn-fsx-filesystem-auditlogconfiguration-fileshareaccessauditloglevel

ClientConfigurationsProperty

class CfnFileSystemPropsMixin.ClientConfigurationsProperty(*, clients=None, options=None)

Bases: object

Specifies who can mount an OpenZFS file system and the options available while mounting the file system.

Parameters:

clients (Optional[str]) – A value that specifies who can mount the file system. You can provide a wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when specifying the client.
options (Optional[Sequence[str]]) – The options to use when mounting the file system. For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page . When choosing your options, consider the following: - crossmnt is used by default. If you don’t specify crossmnt when changing the client configuration, you won’t be able to see or access snapshots in your file system’s snapshot directory. - sync is used by default. If you instead specify async , the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-clientconfigurations.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.mixins_preview.aws_fsx import mixins as fsx_mixins

client_configurations_property = fsx_mixins.CfnFileSystemPropsMixin.ClientConfigurationsProperty(
    clients="clients",
    options=["options"]
)

Attributes

clients

A value that specifies who can mount the file system.

You can provide a wildcard character ( * ), an IP address ( 0.0.0.0 ), or a CIDR address ( 192.0.2.0/24 ). By default, Amazon FSx uses the wildcard character when specifying the client.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-clientconfigurations.html#cfn-fsx-filesystem-clientconfigurations-clients

options

The options to use when mounting the file system.

For a list of options that you can use with Network File System (NFS), see the exports(5) - Linux man page . When choosing your options, consider the following:

crossmnt is used by default. If you don’t specify crossmnt when changing the client configuration, you won’t be able to see or access snapshots in your file system’s snapshot directory.
sync is used by default. If you instead specify async , the system acknowledges writes before writing to disk. If the system crashes before the writes are finished, you lose the unwritten data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-clientconfigurations.html#cfn-fsx-filesystem-clientconfigurations-options

DataReadCacheConfigurationProperty

class CfnFileSystemPropsMixin.DataReadCacheConfigurationProperty(*, size_gib=None, sizing_mode=None)

Bases: object

The configuration for the optional provisioned SSD read cache on Amazon FSx for Lustre file systems that use the Intelligent-Tiering storage class.

Parameters:

size_gib (Union[int, float, None]) – Required if SizingMode is set to USER_PROVISIONED . Specifies the size of the file system’s SSD read cache, in gibibytes (GiB).
sizing_mode (Optional[str]) – Specifies how the provisioned SSD read cache is sized, as follows:. - Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system. - Set to USER_PROVISIONED to specify the exact size of your SSD read cache. - Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-datareadcacheconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

data_read_cache_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.DataReadCacheConfigurationProperty(
    size_gi_b=123,
    sizing_mode="sizingMode"
)

Attributes

size_gib

Required if SizingMode is set to USER_PROVISIONED .

Specifies the size of the file system’s SSD read cache, in gibibytes (GiB).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-datareadcacheconfiguration.html#cfn-fsx-filesystem-datareadcacheconfiguration-sizegib

sizing_mode

.

Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.
Set to USER_PROVISIONED to specify the exact size of your SSD read cache.
Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-datareadcacheconfiguration.html#cfn-fsx-filesystem-datareadcacheconfiguration-sizingmode
Type:: Specifies how the provisioned SSD read cache is sized, as follows

DiskIopsConfigurationProperty

class CfnFileSystemPropsMixin.DiskIopsConfigurationProperty(*, iops=None, mode=None)

Bases: object

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system.

By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

Parameters:

iops (Union[int, float, None]) – The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity . The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity ). The maximum value is calculated as 200,000 * HAPairs . Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.
mode (Optional[str]) – Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-diskiopsconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

disk_iops_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.DiskIopsConfigurationProperty(
    iops=123,
    mode="mode"
)

Attributes

iops

The total number of SSD IOPS provisioned for the file system.

The minimum and maximum values for this property depend on the value of HAPairs and StorageCapacity . The minimum value is calculated as StorageCapacity * 3 * HAPairs (3 IOPS per GB of StorageCapacity ). The maximum value is calculated as 200,000 * HAPairs .

Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of Iops is outside of the minimum or maximum values.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-diskiopsconfiguration.html#cfn-fsx-filesystem-diskiopsconfiguration-iops

mode

Specifies whether the file system is using the AUTOMATIC setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a USER_PROVISIONED value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-diskiopsconfiguration.html#cfn-fsx-filesystem-diskiopsconfiguration-mode

LustreConfigurationProperty

class CfnFileSystemPropsMixin.LustreConfigurationProperty(*, auto_import_policy=None, automatic_backup_retention_days=None, copy_tags_to_backups=None, daily_automatic_backup_start_time=None, data_compression_type=None, data_read_cache_configuration=None, deployment_type=None, drive_cache_type=None, efa_enabled=None, export_path=None, imported_file_chunk_size=None, import_path=None, metadata_configuration=None, per_unit_storage_throughput=None, throughput_capacity=None, weekly_maintenance_start_time=None)

Bases: object

The configuration for the Amazon FSx for Lustre file system.

Parameters:

auto_import_policy (Optional[str]) – (Optional) When you create your file system, your existing S3 objects appear as file and directory listings. Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values: - NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option. - NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system. - NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option. - NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket. For more information, see Automatically import updates from your S3 bucket . .. epigraph:: This parameter is not supported for Lustre file systems with a data repository association.
automatic_backup_retention_days (Union[int, float, None]) – The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0 .
copy_tags_to_backups (Union[bool, IResolvable, None]) – (Optional) Not available for use with file systems that are linked to a data repository. A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If CopyTagsToBackups is set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn’t specify any backup-specific tags. If CopyTagsToBackups is set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value. (Default = false ) For more information, see Working with backups in the Amazon FSx for Lustre User Guide .
daily_automatic_backup_start_time (Optional[str]) – A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
data_compression_type (Optional[str]) – Sets the data compression configuration for the file system. DataCompressionType can have the following values:. - NONE - (Default) Data compression is turned off when the file system is created. - LZ4 - Data compression is turned on with the LZ4 algorithm. For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide .
data_read_cache_configuration (Union[IResolvable, DataReadCacheConfigurationProperty, Dict[str, Any], None]) – Specifies the optional provisioned SSD read cache on FSx for Lustre file systems that use the Intelligent-Tiering storage class. Required when StorageType is set to INTELLIGENT_TIERING .
deployment_type (Optional[str]) – (Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data. The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1 . Choose PERSISTENT_1 for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available. Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2 supports the SSD and Intelligent-Tiering storage classes. You can optionally specify a metadata configuration mode for PERSISTENT_2 which supports increasing metadata performance. PERSISTENT_2 is available in a limited number of AWS Regions . For more information, and an up-to-date list of AWS Regions in which PERSISTENT_2 is available, see Deployment and storage class options for FSx for Lustre file systems in the Amazon FSx for Lustre User Guide . .. epigraph:: If you choose PERSISTENT_2 , and you set FileSystemTypeVersion to 2.10 , the CreateFileSystem operation fails. Encryption of data in transit is automatically turned on when you access SCRATCH_2 , PERSISTENT_1 , and PERSISTENT_2 file systems from Amazon EC2 instances that support automatic encryption in the AWS Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide . (Default = SCRATCH_1 )
drive_cache_type (Optional[str]) – The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices. This parameter is required when storage type is HDD. Set this property to READ to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system. This parameter is required when StorageType is set to HDD and DeploymentType is PERSISTENT_1 .
efa_enabled (Union[bool, IResolvable, None]) – (Optional) Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system. (Default = false )
export_path (Optional[str]) – (Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported. The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp] . The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z . The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath . If you specify only a bucket name, such as s3://import-bucket , you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix] , Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket. .. epigraph:: This parameter is not supported for file systems with a data repository association.
imported_file_chunk_size (Union[int, float, None]) – (Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk. The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system. The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. .. epigraph:: This parameter is not supported for Lustre file systems with a data repository association.
import_path (Optional[str]) – (Optional) The path to the Amazon S3 bucket (including the optional prefix) that you’re using as the data repository for your Amazon FSx for Lustre file system. The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix . If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. .. epigraph:: This parameter is not supported for Lustre file systems with a data repository association.
metadata_configuration (Union[IResolvable, MetadataConfigurationProperty, Dict[str, Any], None]) – The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a PERSISTENT_2 deployment type.
per_unit_storage_throughput (Union[int, float, None]) – Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB. File system throughput capacity is calculated by multiplying ﬁle system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB ﬁle system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of ﬁle system throughput. You pay for the amount of throughput that you provision. Valid values: - For PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB. - For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB. - For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.
throughput_capacity (Union[int, float, None]) – Specifies the throughput of an FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps). Valid values are 4000 MBps or multiples of 4000 MBps. You pay for the amount of throughput that you provision.
weekly_maintenance_start_time (Optional[str]) – The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, 1:05:00 specifies maintenance at 5 AM Monday.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

lustre_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.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",
    data_read_cache_configuration=fsx_mixins.CfnFileSystemPropsMixin.DataReadCacheConfigurationProperty(
        size_gi_b=123,
        sizing_mode="sizingMode"
    ),
    deployment_type="deploymentType",
    drive_cache_type="driveCacheType",
    efa_enabled=False,
    export_path="exportPath",
    imported_file_chunk_size=123,
    import_path="importPath",
    metadata_configuration=fsx_mixins.CfnFileSystemPropsMixin.MetadataConfigurationProperty(
        iops=123,
        mode="mode"
    ),
    per_unit_storage_throughput=123,
    throughput_capacity=123,
    weekly_maintenance_start_time="weeklyMaintenanceStartTime"
)

Attributes

auto_import_policy

(Optional) When you create your file system, your existing S3 objects appear as file and directory listings.

Use this property to choose how Amazon FSx keeps your file and directory listings up to date as you add or modify objects in your linked S3 bucket. AutoImportPolicy can have the following values:

NONE - (Default) AutoImport is off. Amazon FSx only updates file and directory listings from the linked S3 bucket when the file system is created. FSx does not update file and directory listings for any new or changed objects after choosing this option.
NEW - AutoImport is on. Amazon FSx automatically imports directory listings of any new objects added to the linked S3 bucket that do not currently exist in the FSx file system.
NEW_CHANGED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket and any existing objects that are changed in the S3 bucket after you choose this option.
NEW_CHANGED_DELETED - AutoImport is on. Amazon FSx automatically imports file and directory listings of any new objects added to the S3 bucket, any existing objects that are changed in the S3 bucket, and any objects that were deleted in the S3 bucket.

For more information, see Automatically import updates from your S3 bucket . .. epigraph:

This parameter is not supported for Lustre file systems with a data repository association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-autoimportpolicy

automatic_backup_retention_days

The number of days to retain automatic backups.

Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 0 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-automaticbackupretentiondays

copy_tags_to_backups

(Optional) Not available for use with file systems that are linked to a data repository.

A boolean flag indicating whether tags for the file system should be copied to backups. The default value is false. If CopyTagsToBackups is set to true, all file system tags are copied to all automatic and user-initiated backups when the user doesn’t specify any backup-specific tags. If CopyTagsToBackups is set to true and you specify one or more backup tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

(Default = false )

For more information, see Working with backups in the Amazon FSx for Lustre User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-copytagstobackups

daily_automatic_backup_start_time

A recurring daily time, in the format HH:MM .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-dailyautomaticbackupstarttime

data_compression_type

.

NONE - (Default) Data compression is turned off when the file system is created.
LZ4 - Data compression is turned on with the LZ4 algorithm.

For more information, see Lustre data compression in the Amazon FSx for Lustre User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-datacompressiontype
Type:: Sets the data compression configuration for the file system. DataCompressionType can have the following values

data_read_cache_configuration

Specifies the optional provisioned SSD read cache on FSx for Lustre file systems that use the Intelligent-Tiering storage class.

Required when StorageType is set to INTELLIGENT_TIERING .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-datareadcacheconfiguration

deployment_type

(Optional) Choose SCRATCH_1 and SCRATCH_2 deployment types when you need temporary storage and shorter-term processing of data.

The SCRATCH_2 deployment type provides in-transit encryption of data and higher burst throughput capacity than SCRATCH_1 .

Choose PERSISTENT_1 for longer-term storage and for throughput-focused workloads that aren’t latency-sensitive. PERSISTENT_1 supports encryption of data in transit, and is available in all AWS Regions in which FSx for Lustre is available.

Choose PERSISTENT_2 for longer-term storage and for latency-sensitive workloads that require the highest levels of IOPS/throughput. PERSISTENT_2 supports the SSD and Intelligent-Tiering storage classes. You can optionally specify a metadata configuration mode for PERSISTENT_2 which supports increasing metadata performance. PERSISTENT_2 is available in a limited number of AWS Regions . For more information, and an up-to-date list of AWS Regions in which PERSISTENT_2 is available, see Deployment and storage class options for FSx for Lustre file systems in the Amazon FSx for Lustre User Guide . .. epigraph:

If you choose ``PERSISTENT_2`` , and you set ``FileSystemTypeVersion`` to ``2.10`` , the ``CreateFileSystem`` operation fails.

Encryption of data in transit is automatically turned on when you access SCRATCH_2 , PERSISTENT_1 , and PERSISTENT_2 file systems from Amazon EC2 instances that support automatic encryption in the AWS Regions where they are available. For more information about encryption in transit for FSx for Lustre file systems, see Encrypting data in transit in the Amazon FSx for Lustre User Guide .

(Default = SCRATCH_1 )

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-deploymenttype

drive_cache_type

The type of drive cache used by PERSISTENT_1 file systems that are provisioned with HDD storage devices.

This parameter is required when storage type is HDD. Set this property to READ to improve the performance for frequently accessed files by caching up to 20% of the total storage capacity of the file system.

This parameter is required when StorageType is set to HDD and DeploymentType is PERSISTENT_1 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-drivecachetype

efa_enabled

(Optional) Specifies whether Elastic Fabric Adapter (EFA) and GPUDirect Storage (GDS) support is enabled for the Amazon FSx for Lustre file system.

(Default = false )

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-efaenabled

export_path

(Optional) Specifies the path in the Amazon S3 bucket where the root of your Amazon FSx file system is exported.

The path must use the same Amazon S3 bucket as specified in ImportPath. You can provide an optional prefix to which new and changed data is to be exported from your Amazon FSx for Lustre file system. If an ExportPath value is not provided, Amazon FSx sets a default export path, s3://import-bucket/FSxLustre[creation-timestamp] . The timestamp is in UTC format, for example s3://import-bucket/FSxLustre20181105T222312Z .

The Amazon S3 export bucket must be the same as the import bucket specified by ImportPath . If you specify only a bucket name, such as s3://import-bucket , you get a 1:1 mapping of file system objects to S3 bucket objects. This mapping means that the input data in S3 is overwritten on export. If you provide a custom prefix in the export path, such as s3://import-bucket/[custom-optional-prefix] , Amazon FSx exports the contents of your file system to that export prefix in the Amazon S3 bucket. .. epigraph:

This parameter is not supported for file systems with a data repository association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-exportpath

import_path

(Optional) The path to the Amazon S3 bucket (including the optional prefix) that you’re using as the data repository for your Amazon FSx for Lustre file system.

The root of your FSx for Lustre file system will be mapped to the root of the Amazon S3 bucket you select. An example is s3://import-bucket/optional-prefix . If you specify a prefix after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. .. epigraph:

This parameter is not supported for Lustre file systems with a data repository association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-importpath

imported_file_chunk_size

(Optional) For files imported from a data repository, this value determines the stripe count and maximum amount of data per file (in MiB) stored on a single physical disk.

The maximum number of disks that a single file can be striped across is limited by the total number of disks that make up the file system.

The default chunk size is 1,024 MiB (1 GiB) and can go as high as 512,000 MiB (500 GiB). Amazon S3 objects have a maximum size of 5 TB. .. epigraph:

This parameter is not supported for Lustre file systems with a data repository association.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-importedfilechunksize

metadata_configuration

The Lustre metadata performance configuration for the creation of an FSx for Lustre file system using a PERSISTENT_2 deployment type.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-metadataconfiguration

per_unit_storage_throughput

Required with PERSISTENT_1 and PERSISTENT_2 deployment types, provisions the amount of read and write throughput for each 1 tebibyte (TiB) of file system storage capacity, in MB/s/TiB.

File system throughput capacity is calculated by multiplying ﬁle system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB ﬁle system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of ﬁle system throughput. You pay for the amount of throughput that you provision.

Valid values:

For PERSISTENT_1 SSD storage: 50, 100, 200 MB/s/TiB.
For PERSISTENT_1 HDD storage: 12, 40 MB/s/TiB.
For PERSISTENT_2 SSD storage: 125, 250, 500, 1000 MB/s/TiB.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-perunitstoragethroughput

throughput_capacity

Specifies the throughput of an FSx for Lustre file system using the Intelligent-Tiering storage class, measured in megabytes per second (MBps).

Valid values are 4000 MBps or multiples of 4000 MBps. You pay for the amount of throughput that you provision.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-throughputcapacity

weekly_maintenance_start_time

MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-lustreconfiguration.html#cfn-fsx-filesystem-lustreconfiguration-weeklymaintenancestarttime
Type:: The preferred start time to perform weekly maintenance, formatted d
Type:: HH

MetadataConfigurationProperty

class CfnFileSystemPropsMixin.MetadataConfigurationProperty(*, iops=None, mode=None)

Bases: object

The configuration that allows you to specify the performance of metadata operations for an FSx for Lustre file system.

Parameters:

iops (Union[int, float, None]) – The number of Metadata IOPS provisioned for the file system.
mode (Optional[str]) – Specifies whether the file system is using the AUTOMATIC setting of metadata IOPS or if it is using a USER_PROVISIONED value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-metadataconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

metadata_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.MetadataConfigurationProperty(
    iops=123,
    mode="mode"
)

Attributes

iops

The number of Metadata IOPS provisioned for the file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-metadataconfiguration.html#cfn-fsx-filesystem-metadataconfiguration-iops

mode

Specifies whether the file system is using the AUTOMATIC setting of metadata IOPS or if it is using a USER_PROVISIONED value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-metadataconfiguration.html#cfn-fsx-filesystem-metadataconfiguration-mode

NfsExportsProperty

class CfnFileSystemPropsMixin.NfsExportsProperty(*, client_configurations=None)

Bases: object

The configuration object for mounting a file system.

Parameters:: client_configurations (Union[IResolvable, Sequence[Union[IResolvable, ClientConfigurationsProperty, Dict[str, Any]]], None]) – A list of configuration objects that contain the client and options for mounting the OpenZFS file system.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-nfsexports.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.mixins_preview.aws_fsx import mixins as fsx_mixins

nfs_exports_property = fsx_mixins.CfnFileSystemPropsMixin.NfsExportsProperty(
    client_configurations=[fsx_mixins.CfnFileSystemPropsMixin.ClientConfigurationsProperty(
        clients="clients",
        options=["options"]
    )]
)

Attributes

client_configurations

A list of configuration objects that contain the client and options for mounting the OpenZFS file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-nfsexports.html#cfn-fsx-filesystem-nfsexports-clientconfigurations

OntapConfigurationProperty

class CfnFileSystemPropsMixin.OntapConfigurationProperty(*, automatic_backup_retention_days=None, daily_automatic_backup_start_time=None, deployment_type=None, disk_iops_configuration=None, endpoint_ip_address_range=None, endpoint_ipv6_address_range=None, fsx_admin_password=None, ha_pairs=None, preferred_subnet_id=None, route_table_ids=None, throughput_capacity=None, throughput_capacity_per_ha_pair=None, weekly_maintenance_start_time=None)

Bases: object

The configuration for this Amazon FSx for NetApp ONTAP file system.

Parameters:

automatic_backup_retention_days (Union[int, float, None]) – The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30 .
daily_automatic_backup_start_time (Optional[str]) – A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
deployment_type (Optional[str]) – Specifies the FSx for ONTAP file system deployment type to use in creating the file system. - MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. - MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. - SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. - SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type .
disk_iops_configuration (Union[IResolvable, DiskIopsConfigurationProperty, Dict[str, Any], None]) – The SSD IOPS configuration for the FSx for ONTAP file system.
endpoint_ip_address_range (Optional[str]) – (Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don’t overlap with any subnet.
endpoint_ipv6_address_range (Optional[str])
fsx_admin_password (Optional[str]) – The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.
ha_pairs (Union[int, float, None]) – Specifies how many high-availability (HA) pairs of file servers will power your file system. First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1. The value of this property affects the values of StorageCapacity , Iops , and ThroughputCapacity . For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols . Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of HAPairs is less than 1 or greater than 12. - The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 , MULTI_AZ_1 , or MULTI_AZ_2 .
preferred_subnet_id (Optional[str]) – Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2 . This specifies the subnet in which you want the preferred file server to be located.
route_table_ids (Optional[Sequence[str]]) – (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC’s default route table. .. epigraph:: Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with Key: AmazonFSx; Value: ManagedByAmazonFSx . When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the Key: AmazonFSx; Value: ManagedByAmazonFSx tag manually.
throughput_capacity (Union[int, float, None]) – Sets the throughput capacity for the file system that you’re creating in megabytes per second (MBps). For more information, see Managing throughput capacity in the FSx for ONTAP User Guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value. - The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity .
throughput_capacity_per_ha_pair (Union[int, float, None]) – Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system. You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both. This field and ThroughputCapacity are the same for file systems powered by one HA pair. - For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. - For SINGLE_AZ_2 , valid values are 1536, 3072, or 6144 MBps. - For MULTI_AZ_2 , valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair. - The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12). - The value of ThroughputCapacityPerHAPair is not a valid value.
weekly_maintenance_start_time (Optional[str]) – The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, 1:05:00 specifies maintenance at 5 AM Monday.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

ontap_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.OntapConfigurationProperty(
    automatic_backup_retention_days=123,
    daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
    deployment_type="deploymentType",
    disk_iops_configuration=fsx_mixins.CfnFileSystemPropsMixin.DiskIopsConfigurationProperty(
        iops=123,
        mode="mode"
    ),
    endpoint_ip_address_range="endpointIpAddressRange",
    endpoint_ipv6_address_range="endpointIpv6AddressRange",
    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"
)

Attributes

automatic_backup_retention_days

The number of days to retain automatic backups.

Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-automaticbackupretentiondays

daily_automatic_backup_start_time

A recurring daily time, in the format HH:MM .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-dailyautomaticbackupstarttime

deployment_type

Specifies the FSx for ONTAP file system deployment type to use in creating the file system.

MULTI_AZ_1 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system.
MULTI_AZ_2 - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system.
SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system.
SINGLE_AZ_2 - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system.

For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-deploymenttype

disk_iops_configuration

The SSD IOPS configuration for the FSx for ONTAP file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-diskiopsconfiguration

endpoint_ip_address_range

(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created.

By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC’s primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don’t overlap with any subnet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-endpointipaddressrange

endpoint_ipv6_address_range

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-endpointipv6addressrange

Type:: see

fsx_admin_password

The ONTAP administrative password for the fsxadmin user with which you administer your file system using the NetApp ONTAP CLI and REST API.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-fsxadminpassword

ha_pairs

Specifies how many high-availability (HA) pairs of file servers will power your file system.

First-generation file systems are powered by 1 HA pair. Second-generation multi-AZ file systems are powered by 1 HA pair. Second generation single-AZ file systems are powered by up to 12 HA pairs. The default value is 1. The value of this property affects the values of StorageCapacity , Iops , and ThroughputCapacity . For more information, see High-availability (HA) pairs in the FSx for ONTAP user guide. Block storage protocol support (iSCSI and NVMe over TCP) is disabled on file systems with more than 6 HA pairs. For more information, see Using block storage protocols .

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

The value of HAPairs is less than 1 or greater than 12.
The value of HAPairs is greater than 1 and the value of DeploymentType is SINGLE_AZ_1 , MULTI_AZ_1 , or MULTI_AZ_2 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-hapairs

preferred_subnet_id

Required when DeploymentType is set to MULTI_AZ_1 or MULTI_AZ_2 .

This specifies the subnet in which you want the preferred file server to be located.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-preferredsubnetid

route_table_ids

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.

You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC’s default route table. .. epigraph:

Amazon FSx manages these route tables for Multi-AZ file systems using tag-based authentication. These route tables are tagged with ``Key: AmazonFSx; Value: ManagedByAmazonFSx`` . When creating FSx for ONTAP Multi-AZ file systems using CloudFormation we recommend that you add the ``Key: AmazonFSx; Value: ManagedByAmazonFSx`` tag manually.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-routetableids

throughput_capacity

Sets the throughput capacity for the file system that you’re creating in megabytes per second (MBps).

For more information, see Managing throughput capacity in the FSx for ONTAP User Guide.

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value.
The value of ThroughputCapacity when divided by the value of HAPairs is outside of the valid range for ThroughputCapacity .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-throughputcapacity

throughput_capacity_per_ha_pair

Use to choose the throughput capacity per HA pair, rather than the total throughput for the file system.

You can define either the ThroughputCapacityPerHAPair or the ThroughputCapacity when creating a file system, but not both.

This field and ThroughputCapacity are the same for file systems powered by one HA pair.

For SINGLE_AZ_1 and MULTI_AZ_1 file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps.
For SINGLE_AZ_2 , valid values are 1536, 3072, or 6144 MBps.
For MULTI_AZ_2 , valid values are 384, 768, 1536, 3072, or 6144 MBps.

Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:

The value of ThroughputCapacity and ThroughputCapacityPerHAPair are not the same value for file systems with one HA pair.
The value of deployment type is SINGLE_AZ_2 and ThroughputCapacity / ThroughputCapacityPerHAPair is not a valid HA pair (a value between 1 and 12).
The value of ThroughputCapacityPerHAPair is not a valid value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-throughputcapacityperhapair

weekly_maintenance_start_time

MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-ontapconfiguration.html#cfn-fsx-filesystem-ontapconfiguration-weeklymaintenancestarttime
Type:: The preferred start time to perform weekly maintenance, formatted d
Type:: HH

OpenZFSConfigurationProperty

class CfnFileSystemPropsMixin.OpenZFSConfigurationProperty(*, automatic_backup_retention_days=None, copy_tags_to_backups=None, copy_tags_to_volumes=None, daily_automatic_backup_start_time=None, deployment_type=None, disk_iops_configuration=None, endpoint_ip_address_range=None, endpoint_ipv6_address_range=None, options=None, preferred_subnet_id=None, read_cache_configuration=None, root_volume_configuration=None, route_table_ids=None, throughput_capacity=None, weekly_maintenance_start_time=None)

Bases: object

The OpenZFS configuration for the file system that’s being created.

Parameters:

automatic_backup_retention_days (Union[int, float, None]) – The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30 .
copy_tags_to_backups (Union[bool, IResolvable, None]) – A Boolean value indicating whether tags for the file system should be copied to backups. This value defaults to false . If it’s set to true , all tags for the file system are copied to all automatic and user-initiated backups where the user doesn’t specify tags. If this value is true , and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
copy_tags_to_volumes (Union[bool, IResolvable, None]) – A Boolean value indicating whether tags for the file system should be copied to volumes. This value defaults to false . If it’s set to true , all tags for the file system are copied to volumes where the user doesn’t specify tags. If this value is true , and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.
daily_automatic_backup_start_time (Optional[str]) – A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
deployment_type (Optional[str]) – Specifies the file system deployment type. Valid values are the following:. - MULTI_AZ_1 - Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same AWS Region . - SINGLE_AZ_HA_2 - Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone. - SINGLE_AZ_HA_1 - Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone. - SINGLE_AZ_2 - Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within a single Availability Zone. - SINGLE_AZ_1 - Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone. For a list of which AWS Regions each deployment type is available in, see Deployment type availability . For more information on the differences in performance between deployment types, see File system performance in the Amazon FSx for OpenZFS User Guide .
disk_iops_configuration (Union[IResolvable, DiskIopsConfigurationProperty, Dict[str, Any], None]) – The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).
endpoint_ip_address_range (Optional[str]) – (Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC’s CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don’t overlap with any subnet.
endpoint_ipv6_address_range (Optional[str]) – (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC’s CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don’t overlap with any subnet.
options (Optional[Sequence[str]]) – To delete a file system if there are child volumes present below the root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS . If your file system has child volumes and you don’t use this option, the delete request will fail.
preferred_subnet_id (Optional[str]) – Required when DeploymentType is set to MULTI_AZ_1 . This specifies the subnet in which you want the preferred file server to be located.
read_cache_configuration (Union[IResolvable, ReadCacheConfigurationProperty, Dict[str, Any], None]) – Specifies the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.
root_volume_configuration (Union[IResolvable, RootVolumeConfigurationProperty, Dict[str, Any], None]) – The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system. All volumes are children of the root volume.
route_table_ids (Optional[Sequence[str]]) – (Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server. You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC’s default route table.
throughput_capacity (Union[int, float, None]) – Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps). Required if you are creating a new file system. Valid values depend on the DeploymentType that you choose, as follows: - For MULTI_AZ_1 and SINGLE_AZ_2 , valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps. - For SINGLE_AZ_1 , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps. You pay for additional throughput capacity that you provision.
weekly_maintenance_start_time (Optional[str]) – The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. For example, 1:05:00 specifies maintenance at 5 AM Monday.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

open_zFSConfiguration_property = fsx_mixins.CfnFileSystemPropsMixin.OpenZFSConfigurationProperty(
    automatic_backup_retention_days=123,
    copy_tags_to_backups=False,
    copy_tags_to_volumes=False,
    daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
    deployment_type="deploymentType",
    disk_iops_configuration=fsx_mixins.CfnFileSystemPropsMixin.DiskIopsConfigurationProperty(
        iops=123,
        mode="mode"
    ),
    endpoint_ip_address_range="endpointIpAddressRange",
    endpoint_ipv6_address_range="endpointIpv6AddressRange",
    options=["options"],
    preferred_subnet_id="preferredSubnetId",
    read_cache_configuration=fsx_mixins.CfnFileSystemPropsMixin.ReadCacheConfigurationProperty(
        size_gi_b=123,
        sizing_mode="sizingMode"
    ),
    root_volume_configuration=fsx_mixins.CfnFileSystemPropsMixin.RootVolumeConfigurationProperty(
        copy_tags_to_snapshots=False,
        data_compression_type="dataCompressionType",
        nfs_exports=[fsx_mixins.CfnFileSystemPropsMixin.NfsExportsProperty(
            client_configurations=[fsx_mixins.CfnFileSystemPropsMixin.ClientConfigurationsProperty(
                clients="clients",
                options=["options"]
            )]
        )],
        read_only=False,
        record_size_ki_b=123,
        user_and_group_quotas=[fsx_mixins.CfnFileSystemPropsMixin.UserAndGroupQuotasProperty(
            id=123,
            storage_capacity_quota_gi_b=123,
            type="type"
        )]
    ),
    route_table_ids=["routeTableIds"],
    throughput_capacity=123,
    weekly_maintenance_start_time="weeklyMaintenanceStartTime"
)

Attributes

automatic_backup_retention_days

The number of days to retain automatic backups.

Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-automaticbackupretentiondays

copy_tags_to_backups

A Boolean value indicating whether tags for the file system should be copied to backups.

This value defaults to false . If it’s set to true , all tags for the file system are copied to all automatic and user-initiated backups where the user doesn’t specify tags. If this value is true , and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-copytagstobackups

copy_tags_to_volumes

A Boolean value indicating whether tags for the file system should be copied to volumes.

This value defaults to false . If it’s set to true , all tags for the file system are copied to volumes where the user doesn’t specify tags. If this value is true , and you specify one or more tags, only the specified tags are copied to volumes. If you specify one or more tags when creating the volume, no tags are copied from the file system, regardless of this value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-copytagstovolumes

daily_automatic_backup_start_time

A recurring daily time, in the format HH:MM .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-dailyautomaticbackupstarttime

deployment_type

.

MULTI_AZ_1 - Creates file systems with high availability and durability by replicating your data and supporting failover across multiple Availability Zones in the same AWS Region .
SINGLE_AZ_HA_2 - Creates file systems with high availability and throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache by deploying a primary and standby file system within the same Availability Zone.
SINGLE_AZ_HA_1 - Creates file systems with high availability and throughput capacities of 64 - 4,096 MB/s by deploying a primary and standby file system within the same Availability Zone.
SINGLE_AZ_2 - Creates file systems with throughput capacities of 160 - 10,240 MB/s using an NVMe L2ARC cache that automatically recover within a single Availability Zone.
SINGLE_AZ_1 - Creates file systems with throughput capacities of 64 - 4,096 MBs that automatically recover within a single Availability Zone.

For a list of which AWS Regions each deployment type is available in, see Deployment type availability . For more information on the differences in performance between deployment types, see File system performance in the Amazon FSx for OpenZFS User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-deploymenttype
Type:: Specifies the file system deployment type. Valid values are the following

disk_iops_configuration

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system.

By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-diskiopsconfiguration

endpoint_ip_address_range

(Multi-AZ only) Specifies the IPv4 address range in which the endpoints to access your file system will be created.

By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC’s CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don’t overlap with any subnet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-endpointipaddressrange

endpoint_ipv6_address_range

(Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created.

By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /118 IP address range for you from one of the VPC’s CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables, as long as they don’t overlap with any subnet.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-endpointipv6addressrange

options

To delete a file system if there are child volumes present below the root volume, use the string DELETE_CHILD_VOLUMES_AND_SNAPSHOTS .

If your file system has child volumes and you don’t use this option, the delete request will fail.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-options

preferred_subnet_id

Required when DeploymentType is set to MULTI_AZ_1 .

This specifies the subnet in which you want the preferred file server to be located.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-preferredsubnetid

read_cache_configuration

Specifies the optional provisioned SSD read cache on file systems that use the Intelligent-Tiering storage class.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-readcacheconfiguration

root_volume_configuration

The configuration Amazon FSx uses when creating the root value of the Amazon FSx for OpenZFS file system.

All volumes are children of the root volume.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-rootvolumeconfiguration

route_table_ids

(Multi-AZ only) Specifies the route tables in which Amazon FSx creates the rules for routing traffic to the correct file server.

You should specify all virtual private cloud (VPC) route tables associated with the subnets in which your clients are located. By default, Amazon FSx selects your VPC’s default route table.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-routetableids

throughput_capacity

Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MBps).

Required if you are creating a new file system.

Valid values depend on the DeploymentType that you choose, as follows:

For MULTI_AZ_1 and SINGLE_AZ_2 , valid values are 160, 320, 640, 1280, 2560, 3840, 5120, 7680, or 10240 MBps.
For SINGLE_AZ_1 , valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MBps.

You pay for additional throughput capacity that you provision.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-throughputcapacity

weekly_maintenance_start_time

MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

For example, 1:05:00 specifies maintenance at 5 AM Monday.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-openzfsconfiguration.html#cfn-fsx-filesystem-openzfsconfiguration-weeklymaintenancestarttime
Type:: The preferred start time to perform weekly maintenance, formatted d
Type:: HH

ReadCacheConfigurationProperty

class CfnFileSystemPropsMixin.ReadCacheConfigurationProperty(*, size_gib=None, sizing_mode=None)

Bases: object

The configuration for the optional provisioned SSD read cache on Amazon FSx for OpenZFS file systems that use the Intelligent-Tiering storage class.

Parameters:

size_gib (Union[int, float, None]) – Required if SizingMode is set to USER_PROVISIONED . Specifies the size of the file system’s SSD read cache, in gibibytes (GiB).
sizing_mode (Optional[str]) – Specifies how the provisioned SSD read cache is sized, as follows:. - Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system. - Set to USER_PROVISIONED to specify the exact size of your SSD read cache. - Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-readcacheconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

read_cache_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.ReadCacheConfigurationProperty(
    size_gi_b=123,
    sizing_mode="sizingMode"
)

Attributes

size_gib

Required if SizingMode is set to USER_PROVISIONED .

Specifies the size of the file system’s SSD read cache, in gibibytes (GiB).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-readcacheconfiguration.html#cfn-fsx-filesystem-readcacheconfiguration-sizegib

sizing_mode

.

Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.
Set to USER_PROVISIONED to specify the exact size of your SSD read cache.
Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-readcacheconfiguration.html#cfn-fsx-filesystem-readcacheconfiguration-sizingmode
Type:: Specifies how the provisioned SSD read cache is sized, as follows

RootVolumeConfigurationProperty

class CfnFileSystemPropsMixin.RootVolumeConfigurationProperty(*, copy_tags_to_snapshots=None, data_compression_type=None, nfs_exports=None, read_only=None, record_size_kib=None, user_and_group_quotas=None)

Bases: object

The configuration of an Amazon FSx for OpenZFS root volume.

Parameters:

copy_tags_to_snapshots (Union[bool, IResolvable, None]) – A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume. This value defaults to false . If it’s set to true , all tags for the volume are copied to snapshots where the user doesn’t specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.
data_compression_type (Optional[str]) – Specifies the method used to compress the data on the volume. The compression type is NONE by default. - NONE - Doesn’t compress the data on the volume. NONE is the default. - ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization. - LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.
nfs_exports (Union[IResolvable, Sequence[Union[IResolvable, NfsExportsProperty, Dict[str, Any]]], None]) – The configuration object for mounting a file system.
read_only (Union[bool, IResolvable, None]) – A Boolean value indicating whether the volume is read-only. Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.
record_size_kib (Union[int, float, None]) – Specifies the record size of an OpenZFS root volume, in kibibytes (KiB). Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide .
user_and_group_quotas (Union[IResolvable, Sequence[Union[IResolvable, UserAndGroupQuotasProperty, Dict[str, Any]]], None]) – An object specifying how much storage users or groups can use on the volume.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

root_volume_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.RootVolumeConfigurationProperty(
    copy_tags_to_snapshots=False,
    data_compression_type="dataCompressionType",
    nfs_exports=[fsx_mixins.CfnFileSystemPropsMixin.NfsExportsProperty(
        client_configurations=[fsx_mixins.CfnFileSystemPropsMixin.ClientConfigurationsProperty(
            clients="clients",
            options=["options"]
        )]
    )],
    read_only=False,
    record_size_ki_b=123,
    user_and_group_quotas=[fsx_mixins.CfnFileSystemPropsMixin.UserAndGroupQuotasProperty(
        id=123,
        storage_capacity_quota_gi_b=123,
        type="type"
    )]
)

Attributes

copy_tags_to_snapshots

A Boolean value indicating whether tags for the volume should be copied to snapshots of the volume.

This value defaults to false . If it’s set to true , all tags for the volume are copied to snapshots where the user doesn’t specify tags. If this value is true and you specify one or more tags, only the specified tags are copied to snapshots. If you specify one or more tags when creating the snapshot, no tags are copied from the volume, regardless of this value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-copytagstosnapshots

data_compression_type

Specifies the method used to compress the data on the volume. The compression type is NONE by default.

NONE - Doesn’t compress the data on the volume. NONE is the default.
ZSTD - Compresses the data in the volume using the Zstandard (ZSTD) compression algorithm. Compared to LZ4, Z-Standard provides a better compression ratio to minimize on-disk storage utilization.
LZ4 - Compresses the data in the volume using the LZ4 compression algorithm. Compared to Z-Standard, LZ4 is less compute-intensive and delivers higher write throughput speeds.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-datacompressiontype

nfs_exports

The configuration object for mounting a file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-nfsexports

read_only

A Boolean value indicating whether the volume is read-only.

Setting this value to true can be useful after you have completed changes to a volume and no longer want changes to occur.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-readonly

record_size_kib

Specifies the record size of an OpenZFS root volume, in kibibytes (KiB).

Valid values are 4, 8, 16, 32, 64, 128, 256, 512, or 1024 KiB. The default is 128 KiB. Most workloads should use the default record size. Database workflows can benefit from a smaller record size, while streaming workflows can benefit from a larger record size. For additional guidance on setting a custom record size, see Tips for maximizing performance in the Amazon FSx for OpenZFS User Guide .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-recordsizekib

user_and_group_quotas

An object specifying how much storage users or groups can use on the volume.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-rootvolumeconfiguration.html#cfn-fsx-filesystem-rootvolumeconfiguration-userandgroupquotas

SelfManagedActiveDirectoryConfigurationProperty

class CfnFileSystemPropsMixin.SelfManagedActiveDirectoryConfigurationProperty(*, dns_ips=None, domain_join_service_account_secret=None, domain_name=None, file_system_administrators_group=None, organizational_unit_distinguished_name=None, password=None, user_name=None)

Bases: object

The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.

For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs .

Parameters:

dns_ips (Optional[Sequence[str]]) – A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.
domain_join_service_account_secret (Optional[str]) –
The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the self-managed Active Directory domain join service account credentials. When provided, Amazon FSx uses the credentials stored in this secret to join the file system to your self-managed Active Directory domain. The secret must contain two key-value pairs: - CUSTOMER_MANAGED_ACTIVE_DIRECTORY_USERNAME - The username for the service account - CUSTOMER_MANAGED_ACTIVE_DIRECTORY_PASSWORD - The password for the service account For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Using Amazon FSx for ONTAP with your self-managed Microsoft Active Directory .
domain_name (Optional[str]) – The fully qualified domain name of the self-managed AD directory, such as corp.example.com .
file_system_administrators_group (Optional[str]) – (Optional) The name of the domain group whose members are granted administrative privileges for the file system. Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don’t provide one, your AD domain’s Domain Admins group is used.
organizational_unit_distinguished_name (Optional[str]) – (Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory. Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com . To learn more, see RFC 2253 . If none is provided, the FSx file system is created in the default location of your self-managed AD directory. .. epigraph:: Only Organizational Unit (OU) objects can be the direct parent of the file system that you’re creating.
password (Optional[str]) – The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.
user_name (Optional[str]) – The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain. This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName , or in the default location of your AD domain.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-selfmanagedactivedirectoryconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

self_managed_active_directory_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.SelfManagedActiveDirectoryConfigurationProperty(
    dns_ips=["dnsIps"],
    domain_join_service_account_secret="domainJoinServiceAccountSecret",
    domain_name="domainName",
    file_system_administrators_group="fileSystemAdministratorsGroup",
    organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
    password="password",
    user_name="userName"
)

Attributes

dns_ips

A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-selfmanagedactivedirectoryconfiguration-dnsips

domain_join_service_account_secret

The Amazon Resource Name (ARN) of the AWS Secrets Manager secret containing the self-managed Active Directory domain join service account credentials.

When provided, Amazon FSx uses the credentials stored in this secret to join the file system to your self-managed Active Directory domain.

The secret must contain two key-value pairs:

CUSTOMER_MANAGED_ACTIVE_DIRECTORY_USERNAME - The username for the service account
CUSTOMER_MANAGED_ACTIVE_DIRECTORY_PASSWORD - The password for the service account

For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Using Amazon FSx for ONTAP with your self-managed Microsoft Active Directory .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-selfmanagedactivedirectoryconfiguration-domainjoinserviceaccountsecret

domain_name

The fully qualified domain name of the self-managed AD directory, such as corp.example.com .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-selfmanagedactivedirectoryconfiguration-domainname

file_system_administrators_group

(Optional) The name of the domain group whose members are granted administrative privileges for the file system.

Administrative privileges include taking ownership of files and folders, setting audit controls (audit ACLs) on files and folders, and administering the file system remotely by using the FSx Remote PowerShell. The group that you specify must already exist in your domain. If you don’t provide one, your AD domain’s Domain Admins group is used.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-selfmanagedactivedirectoryconfiguration-filesystemadministratorsgroup

organizational_unit_distinguished_name

(Optional) The fully qualified distinguished name of the organizational unit within your self-managed AD directory.

Amazon FSx only accepts OU as the direct parent of the file system. An example is OU=FSx,DC=yourdomain,DC=corp,DC=com . To learn more, see RFC 2253 . If none is provided, the FSx file system is created in the default location of your self-managed AD directory. .. epigraph:

Only Organizational Unit (OU) objects can be the direct parent of the file system that you're creating.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-selfmanagedactivedirectoryconfiguration-organizationalunitdistinguishedname

password

The password for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-selfmanagedactivedirectoryconfiguration-password

user_name

The user name for the service account on your self-managed AD domain that Amazon FSx will use to join to your AD domain.

This account must have the permission to join computers to the domain in the organizational unit provided in OrganizationalUnitDistinguishedName , or in the default location of your AD domain.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-selfmanagedactivedirectoryconfiguration.html#cfn-fsx-filesystem-selfmanagedactivedirectoryconfiguration-username

UserAndGroupQuotasProperty

class CfnFileSystemPropsMixin.UserAndGroupQuotasProperty(*, id=None, storage_capacity_quota_gib=None, type=None)

Bases: object

Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume.

For more information, see Volume properties in the FSx for OpenZFS User Guide.

Parameters:

id (Union[int, float, None]) – The ID of the user or group that the quota applies to.
storage_capacity_quota_gib (Union[int, float, None]) – The user or group’s storage quota, in gibibytes (GiB).
type (Optional[str]) – Specifies whether the quota applies to a user or group.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-userandgroupquotas.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.mixins_preview.aws_fsx import mixins as fsx_mixins

user_and_group_quotas_property = fsx_mixins.CfnFileSystemPropsMixin.UserAndGroupQuotasProperty(
    id=123,
    storage_capacity_quota_gi_b=123,
    type="type"
)

Attributes

id

The ID of the user or group that the quota applies to.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-userandgroupquotas.html#cfn-fsx-filesystem-userandgroupquotas-id

storage_capacity_quota_gib

The user or group’s storage quota, in gibibytes (GiB).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-userandgroupquotas.html#cfn-fsx-filesystem-userandgroupquotas-storagecapacityquotagib

type

Specifies whether the quota applies to a user or group.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-userandgroupquotas.html#cfn-fsx-filesystem-userandgroupquotas-type

WindowsConfigurationProperty

class CfnFileSystemPropsMixin.WindowsConfigurationProperty(*, active_directory_id=None, aliases=None, audit_log_configuration=None, automatic_backup_retention_days=None, copy_tags_to_backups=None, daily_automatic_backup_start_time=None, deployment_type=None, disk_iops_configuration=None, preferred_subnet_id=None, self_managed_active_directory_configuration=None, throughput_capacity=None, weekly_maintenance_start_time=None)

Bases: object

The Microsoft Windows configuration for the file system that’s being created.

Parameters:

active_directory_id (Optional[str]) – The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it’s created. Required if you are joining the file system to an existing AWS Managed Microsoft AD.
aliases (Optional[Sequence[str]]) – An array of one or more DNS alias names that you want to associate with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system , including additional steps you must take to be able to access your file system using a DNS alias. An alias name has to meet the following requirements: - Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com . - Can contain alphanumeric characters, the underscore (_), and the hyphen (-). - Cannot start or end with a hyphen. - Can start with a numeric. For DNS alias names, Amazon FSx stores alphabetical characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.
audit_log_configuration (Union[IResolvable, AuditLogConfigurationProperty, Dict[str, Any], None]) – The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.
automatic_backup_retention_days (Union[int, float, None]) – The number of days to retain automatic backups. Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30 .
copy_tags_to_backups (Union[bool, IResolvable, None]) – A boolean flag indicating whether tags for the file system should be copied to backups. This value defaults to false. If it’s set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn’t specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.
daily_automatic_backup_start_time (Optional[str]) – A recurring daily time, in the format HH:MM . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.
deployment_type (Optional[str]) – Specifies the file system deployment type, valid values are the following:. - MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type - SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy. - SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type. For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems .
disk_iops_configuration (Union[IResolvable, DiskIopsConfigurationProperty, Dict[str, Any], None]) – The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.
preferred_subnet_id (Optional[str]) – Required when DeploymentType is set to MULTI_AZ_1 . This specifies the subnet in which you want the preferred file server to be located. For in- AWS applications, we recommend that you launch your clients in the same availability zone as your preferred file server to reduce cross-availability zone data transfer costs and minimize latency.
self_managed_active_directory_configuration (Union[IResolvable, SelfManagedActiveDirectoryConfigurationProperty, Dict[str, Any], None]) –
The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs .
throughput_capacity (Union[int, float, None]) – Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the n th increments, between 2^3 (8) and 2^11 (2048). .. epigraph:: To increase storage capacity, a file system must have a minimum throughput capacity of 16 MB/s.
weekly_maintenance_start_time (Optional[str]) – The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.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.mixins_preview.aws_fsx import mixins as fsx_mixins

windows_configuration_property = fsx_mixins.CfnFileSystemPropsMixin.WindowsConfigurationProperty(
    active_directory_id="activeDirectoryId",
    aliases=["aliases"],
    audit_log_configuration=fsx_mixins.CfnFileSystemPropsMixin.AuditLogConfigurationProperty(
        audit_log_destination="auditLogDestination",
        file_access_audit_log_level="fileAccessAuditLogLevel",
        file_share_access_audit_log_level="fileShareAccessAuditLogLevel"
    ),
    automatic_backup_retention_days=123,
    copy_tags_to_backups=False,
    daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
    deployment_type="deploymentType",
    disk_iops_configuration=fsx_mixins.CfnFileSystemPropsMixin.DiskIopsConfigurationProperty(
        iops=123,
        mode="mode"
    ),
    preferred_subnet_id="preferredSubnetId",
    self_managed_active_directory_configuration=fsx_mixins.CfnFileSystemPropsMixin.SelfManagedActiveDirectoryConfigurationProperty(
        dns_ips=["dnsIps"],
        domain_join_service_account_secret="domainJoinServiceAccountSecret",
        domain_name="domainName",
        file_system_administrators_group="fileSystemAdministratorsGroup",
        organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
        password="password",
        user_name="userName"
    ),
    throughput_capacity=123,
    weekly_maintenance_start_time="weeklyMaintenanceStartTime"
)

Attributes

active_directory_id

The ID for an existing AWS Managed Microsoft Active Directory (AD) instance that the file system should join when it’s created.

Required if you are joining the file system to an existing AWS Managed Microsoft AD.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-activedirectoryid

aliases

An array of one or more DNS alias names that you want to associate with the Amazon FSx file system.

Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time.

For more information, see Working with DNS Aliases and Walkthrough 5: Using DNS aliases to access your file system , including additional steps you must take to be able to access your file system using a DNS alias.

An alias name has to meet the following requirements:

Formatted as a fully-qualified domain name (FQDN), hostname.domain , for example, accounting.example.com .
Can contain alphanumeric characters, the underscore (_), and the hyphen (-).
Cannot start or end with a hyphen.
Can start with a numeric.

For DNS alias names, Amazon FSx stores alphabetical characters as lowercase letters (a-z), regardless of how you specify them: as uppercase letters, lowercase letters, or the corresponding letters in escape codes.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-aliases

audit_log_configuration

The configuration that Amazon FSx for Windows File Server uses to audit and log user accesses of files, folders, and file shares on the Amazon FSx for Windows File Server file system.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-auditlogconfiguration

automatic_backup_retention_days

The number of days to retain automatic backups.

Setting this property to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. The default is 30 .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-automaticbackupretentiondays

copy_tags_to_backups

A boolean flag indicating whether tags for the file system should be copied to backups.

This value defaults to false. If it’s set to true, all tags for the file system are copied to all automatic and user-initiated backups where the user doesn’t specify tags. If this value is true, and you specify one or more tags, only the specified tags are copied to backups. If you specify one or more tags when creating a user-initiated backup, no tags are copied from the file system, regardless of this value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-copytagstobackups

daily_automatic_backup_start_time

A recurring daily time, in the format HH:MM .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 05:00 specifies 5 AM daily.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-dailyautomaticbackupstarttime

deployment_type

.

MULTI_AZ_1 - Deploys a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. You can only deploy a Multi-AZ file system in AWS Regions that have a minimum of three Availability Zones. Also supports HDD storage type
SINGLE_AZ_1 - (Default) Choose to deploy a file system that is configured for single AZ redundancy.
SINGLE_AZ_2 - The latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports HDD storage type.

For more information, see Availability and Durability: Single-AZ and Multi-AZ File Systems .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-deploymenttype
Type:: Specifies the file system deployment type, valid values are the following

disk_iops_configuration

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system.

By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-diskiopsconfiguration

preferred_subnet_id

Required when DeploymentType is set to MULTI_AZ_1 .

This specifies the subnet in which you want the preferred file server to be located. For in- AWS applications, we recommend that you launch your clients in the same availability zone as your preferred file server to reduce cross-availability zone data transfer costs and minimize latency.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-preferredsubnetid

self_managed_active_directory_configuration

The configuration that Amazon FSx uses to join a FSx for Windows File Server file system or an FSx for ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.

For more information, see Using Amazon FSx for Windows with your self-managed Microsoft Active Directory or Managing FSx for ONTAP SVMs .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-selfmanagedactivedirectoryconfiguration

throughput_capacity

Sets the throughput capacity of an Amazon FSx file system, measured in megabytes per second (MB/s), in 2 to the n th increments, between 2^3 (8) and 2^11 (2048).

To increase storage capacity, a file system must have a minimum throughput capacity of 16 MB/s.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-throughputcapacity

weekly_maintenance_start_time

MM in the UTC time zone, where d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-fsx-filesystem-windowsconfiguration.html#cfn-fsx-filesystem-windowsconfiguration-weeklymaintenancestarttime
Type:: The preferred start time to perform weekly maintenance, formatted d
Type:: HH