CfnFileSystem

class aws_cdk.aws_fsx.CfnFileSystem(scope, id, *, file_system_type, subnet_ids, backup_id=None, file_system_type_version=None, kms_key_id=None, lustre_configuration=None, ontap_configuration=None, open_zfs_configuration=None, security_group_ids=None, storage_capacity=None, storage_type=None, tags=None, windows_configuration=None)

Bases: aws_cdk.core.CfnResource

A CloudFormation AWS::FSx::FileSystem.

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

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

CloudformationResource

AWS::FSx::FileSystem

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_fsx as fsx

cfn_file_system = fsx.CfnFileSystem(self, "MyCfnFileSystem",
    file_system_type="fileSystemType",
    subnet_ids=["subnetIds"],

    # the properties below are optional
    backup_id="backupId",
    file_system_type_version="fileSystemTypeVersion",
    kms_key_id="kmsKeyId",
    lustre_configuration=fsx.CfnFileSystem.LustreConfigurationProperty(
        auto_import_policy="autoImportPolicy",
        automatic_backup_retention_days=123,
        copy_tags_to_backups=False,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        data_compression_type="dataCompressionType",
        deployment_type="deploymentType",
        drive_cache_type="driveCacheType",
        export_path="exportPath",
        imported_file_chunk_size=123,
        import_path="importPath",
        per_unit_storage_throughput=123,
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    ),
    ontap_configuration=fsx.CfnFileSystem.OntapConfigurationProperty(
        deployment_type="deploymentType",

        # the properties below are optional
        automatic_backup_retention_days=123,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        disk_iops_configuration=fsx.CfnFileSystem.DiskIopsConfigurationProperty(
            iops=123,
            mode="mode"
        ),
        endpoint_ip_address_range="endpointIpAddressRange",
        fsx_admin_password="fsxAdminPassword",
        preferred_subnet_id="preferredSubnetId",
        route_table_ids=["routeTableIds"],
        throughput_capacity=123,
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    ),
    open_zfs_configuration=fsx.CfnFileSystem.OpenZFSConfigurationProperty(
        deployment_type="deploymentType",

        # the properties below are optional
        automatic_backup_retention_days=123,
        copy_tags_to_backups=False,
        copy_tags_to_volumes=False,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        disk_iops_configuration=fsx.CfnFileSystem.DiskIopsConfigurationProperty(
            iops=123,
            mode="mode"
        ),
        options=["options"],
        root_volume_configuration=fsx.CfnFileSystem.RootVolumeConfigurationProperty(
            copy_tags_to_snapshots=False,
            data_compression_type="dataCompressionType",
            nfs_exports=[fsx.CfnFileSystem.NfsExportsProperty(
                client_configurations=[fsx.CfnFileSystem.ClientConfigurationsProperty(
                    clients="clients",
                    options=["options"]
                )]
            )],
            read_only=False,
            record_size_ki_b=123,
            user_and_group_quotas=[fsx.CfnFileSystem.UserAndGroupQuotasProperty(
                id=123,
                storage_capacity_quota_gi_b=123,
                type="type"
            )]
        ),
        throughput_capacity=123,
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    ),
    security_group_ids=["securityGroupIds"],
    storage_capacity=123,
    storage_type="storageType",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    windows_configuration=fsx.CfnFileSystem.WindowsConfigurationProperty(
        throughput_capacity=123,

        # the properties below are optional
        active_directory_id="activeDirectoryId",
        aliases=["aliases"],
        audit_log_configuration=fsx.CfnFileSystem.AuditLogConfigurationProperty(
            file_access_audit_log_level="fileAccessAuditLogLevel",
            file_share_access_audit_log_level="fileShareAccessAuditLogLevel",

            # the properties below are optional
            audit_log_destination="auditLogDestination"
        ),
        automatic_backup_retention_days=123,
        copy_tags_to_backups=False,
        daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
        deployment_type="deploymentType",
        preferred_subnet_id="preferredSubnetId",
        self_managed_active_directory_configuration=fsx.CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty(
            dns_ips=["dnsIps"],
            domain_name="domainName",
            file_system_administrators_group="fileSystemAdministratorsGroup",
            organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
            password="password",
            user_name="userName"
        ),
        weekly_maintenance_start_time="weeklyMaintenanceStartTime"
    )
)

Create a new AWS::FSx::FileSystem.

Parameters
  • scope (Construct) –

    • scope in which this resource is defined.

  • id (str) –

    • scoped id of the resource.

  • file_system_type (str) – The type of Amazon FSx file system, which can be LUSTRE , WINDOWS , ONTAP , or OPENZFS .

  • subnet_ids (Sequence[str]) – Specifies the IDs of the subnets that the file system will be accessible from. For Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide . For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet’s Availability Zone.

  • backup_id (Optional[str]) – The ID of the file system backup that you are using to create a file system. For more information, see CreateFileSystemFromBackup .

  • file_system_type_version (Optional[str]) – (Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you’re creating. Valid values are 2.10 and 2.12 : - 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types. - 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2 . Default value = 2.10 , except when DeploymentType is set to PERSISTENT_2 , then the default is 2.12 . .. epigraph:: If you set FileSystemTypeVersion to 2.10 for a PERSISTENT_2 Lustre deployment type, the CreateFileSystem operation fails.

  • kms_key_id (Optional[str]) – The ID of the AWS Key Management Service ( AWS KMS ) key used to encrypt Amazon FSx file system data. Used as follows with Amazon FSx file system types: - Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only. SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service AWS KMS key for your account. - Amazon FSx for NetApp ONTAP - Amazon FSx for OpenZFS - Amazon FSx for Windows File Server

  • lustre_configuration (Union[LustreConfigurationProperty, Dict[str, Any], IResolvable, None]) – The Lustre configuration for the file system being created. .. epigraph:: The following parameters are not supported for file systems with the Lustre Persistent_2 deployment type. - AutoImportPolicy - ExportPath - ImportedChunkSize - ImportPath

  • ontap_configuration (Union[IResolvable, OntapConfigurationProperty, Dict[str, Any], None]) – The ONTAP configuration properties of the FSx for ONTAP file system that you are creating.

  • open_zfs_configuration (Union[IResolvable, OpenZFSConfigurationProperty, Dict[str, Any], None]) – The Amazon FSx for OpenZFS configuration properties for the file system that you are creating.

  • security_group_ids (Optional[Sequence[str]]) – A list of IDs specifying the security groups to apply to all network interfaces created for file system access. This list isn’t returned in later requests to describe the file system.

  • storage_capacity (Union[int, float, None]) – Sets the storage capacity of the file system that you’re creating. StorageCapacity is required if you are creating a new file system. Do not include StorageCapacity if you are creating a file system from a backup. FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType , as follows: - For SCRATCH_2 , PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB. - For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems. - For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB. FSx for ONTAP file systems - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB). FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB). FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows: - For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB). - For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).

  • storage_type (Optional[str]) – Sets the storage type for the file system that you’re creating. Valid values are SSD and HDD . - Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types. - Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types. Default value is SSD . For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide .

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – An array of key-value pairs to apply to this resource. For more information, see Tag .

  • windows_configuration (Union[IResolvable, WindowsConfigurationProperty, Dict[str, Any], None]) – The configuration object for the Microsoft Windows file system you are creating. This value is required if FileSystemType is set to WINDOWS .

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters

path (str) – The path of the value to delete.

Return type

None

add_depends_on(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters

target (CfnResource) –

Return type

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters
  • key (str) –

  • value (Any) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

None

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
   "GlobalSecondaryIndexes": [
     {
       "Projection": {
         "NonKeyAttributes": [ "myattribute" ]
         ...
       }
       ...
     },
     {
       "ProjectionType": "INCLUDE"
       ...
     },
   ]
   ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters
  • path (str) –

    • The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.

  • value (Any) –

    • The value. Could be primitive or complex.

Return type

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters

property_path (str) – The path to the property.

Return type

None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters
  • property_path (str) – The path of the property.

  • value (Any) – The value.

Return type

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters
  • policy (Optional[RemovalPolicy]) –

  • apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true

  • default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.

Return type

None

get_att(attribute_name)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters

attribute_name (str) – The name of the attribute.

Return type

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters

key (str) –

See

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

Return type

Any

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters

inspector (TreeInspector) –

  • tree inspector to collect and process attributes.

Return type

None

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters

new_logical_id (str) – The new logical ID to use for this stack element.

Return type

None

to_string()

Returns a string representation of this construct.

Return type

str

Returns

a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::FSx::FileSystem'
attr_dns_name

Returns the FSx for Windows file system’s DNSName.

Example: amznfsxp1honlek.corp.example.com

CloudformationAttribute

DNSName

Return type

str

attr_lustre_mount_name

Returns the file system’s LustreMountName.

Example for SCRATCH_1 deployment types: This value is always fsx .

Example for SCRATCH_2 and PERSISTENT deployment types: 2p3fhbmv

CloudformationAttribute

LustreMountName

Return type

str

attr_root_volume_id

Returns the root volume ID of the FSx for OpenZFS file system.

Example: fsvol-0123456789abcdefa

CloudformationAttribute

RootVolumeId

Return type

str

backup_id

The ID of the file system backup that you are using to create a file system.

For more information, see CreateFileSystemFromBackup .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-backupid

Return type

Optional[str]

cfn_options

Options for this resource, such as condition, update policy etc.

Return type

ICfnResourceOptions

cfn_resource_type

AWS resource type.

Return type

str

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

Return type

List[str]

file_system_type

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtype

Return type

str

file_system_type_version

(Optional) For FSx for Lustre file systems, sets the Lustre version for the file system that you’re creating.

Valid values are 2.10 and 2.12 :

  • 2.10 is supported by the Scratch and Persistent_1 Lustre deployment types.

  • 2.12 is supported by all Lustre deployment types. 2.12 is required when setting FSx for Lustre DeploymentType to PERSISTENT_2 .

Default value = 2.10 , except when DeploymentType is set to PERSISTENT_2 , then the default is 2.12 . .. epigraph:

If you set ``FileSystemTypeVersion`` to ``2.10`` for a ``PERSISTENT_2`` Lustre deployment type, the ``CreateFileSystem`` operation fails.
Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-filesystemtypeversion

Return type

Optional[str]

kms_key_id

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

Used as follows with Amazon FSx file system types:

  • Amazon FSx for Lustre PERSISTENT_1 and PERSISTENT_2 deployment types only.

SCRATCH_1 and SCRATCH_2 types are encrypted using the Amazon FSx service AWS KMS key for your account.

  • Amazon FSx for NetApp ONTAP

  • Amazon FSx for OpenZFS

  • Amazon FSx for Windows File Server

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-kmskeyid

Return type

Optional[str]

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Return type

str

Returns

the logical ID as a stringified token. This value will only get resolved during synthesis.

lustre_configuration

The Lustre configuration for the file system being created.

The following parameters are not supported for file systems with the Lustre Persistent_2 deployment type.

  • AutoImportPolicy

  • ExportPath

  • ImportedChunkSize

  • ImportPath

Link

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

Return type

Union[LustreConfigurationProperty, IResolvable, None]

node

The construct tree node associated with this construct.

Return type

ConstructNode

ontap_configuration

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

Link

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

Return type

Union[IResolvable, OntapConfigurationProperty, None]

open_zfs_configuration

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

Link

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

Return type

Union[IResolvable, OpenZFSConfigurationProperty, None]

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Return type

str

security_group_ids

A list of IDs specifying the security groups to apply to all network interfaces created for file system access.

This list isn’t returned in later requests to describe the file system.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-securitygroupids

Return type

Optional[List[str]]

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Return type

Stack

storage_capacity

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

StorageCapacity is required if you are creating a new file system. Do not include StorageCapacity if you are creating a file system from a backup.

FSx for Lustre file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType and the Lustre DeploymentType , as follows:

  • For SCRATCH_2 , PERSISTENT_2 and PERSISTENT_1 deployment types using SSD storage type, the valid values are 1200 GiB, 2400 GiB, and increments of 2400 GiB.

  • For PERSISTENT_1 HDD file systems, valid values are increments of 6000 GiB for 12 MB/s/TiB file systems and increments of 1800 GiB for 40 MB/s/TiB file systems.

  • For SCRATCH_1 deployment type, valid values are 1200 GiB, 2400 GiB, and increments of 3600 GiB.

FSx for ONTAP file systems - The amount of storage capacity that you can configure is from 1024 GiB up to 196,608 GiB (192 TiB).

FSx for OpenZFS file systems - The amount of storage capacity that you can configure is from 64 GiB up to 524,288 GiB (512 TiB).

FSx for Windows File Server file systems - The amount of storage capacity that you can configure depends on the value that you set for StorageType as follows:

  • For SSD storage, valid values are 32 GiB-65,536 GiB (64 TiB).

  • For HDD storage, valid values are 2000 GiB-65,536 GiB (64 TiB).

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagecapacity

Return type

Union[int, float, None]

storage_type

Sets the storage type for the file system that you’re creating. Valid values are SSD and HDD .

  • Set to SSD to use solid state drive storage. SSD is supported on all Windows, Lustre, ONTAP, and OpenZFS deployment types.

  • Set to HDD to use hard disk drive storage. HDD is supported on SINGLE_AZ_2 and MULTI_AZ_1 Windows file system deployment types, and on PERSISTENT_1 Lustre file system deployment types.

Default value is SSD . For more information, see Storage type options in the FSx for Windows File Server User Guide and Multiple storage options in the FSx for Lustre User Guide .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-storagetype

Return type

Optional[str]

subnet_ids

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

For Windows and ONTAP MULTI_AZ_1 deployment types,provide exactly two subnet IDs, one for the preferred file server and one for the standby file server. You specify one of these subnets as the preferred subnet using the WindowsConfiguration > PreferredSubnetID or OntapConfiguration > PreferredSubnetID properties. For more information about Multi-AZ file system configuration, see Availability and durability: Single-AZ and Multi-AZ file systems in the Amazon FSx for Windows User Guide and Availability and durability in the Amazon FSx for ONTAP User Guide .

For Windows SINGLE_AZ_1 and SINGLE_AZ_2 and all Lustre deployment types, provide exactly one subnet ID. The file server is launched in that subnet’s Availability Zone.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-subnetids

Return type

List[str]

tags

An array of key-value pairs to apply to this resource.

For more information, see Tag .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fsx-filesystem.html#cfn-fsx-filesystem-tags

Return type

TagManager

windows_configuration

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

This value is required if FileSystemType is set to WINDOWS .

Link

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

Return type

Union[IResolvable, WindowsConfigurationProperty, None]

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters

x (Any) –

Return type

bool

Returns

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(construct)

Check whether the given construct is a CfnResource.

Parameters

construct (IConstruct) –

Return type

bool

classmethod is_construct(x)

Return whether the given object is a Construct.

Parameters

x (Any) –

Return type

bool

AuditLogConfigurationProperty

class CfnFileSystem.AuditLogConfigurationProperty(*, file_access_audit_log_level, file_share_access_audit_log_level, audit_log_destination=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
  • file_access_audit_log_level (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 (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.

  • 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 Firehouse 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.

Link

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

audit_log_configuration_property = fsx.CfnFileSystem.AuditLogConfigurationProperty(
    file_access_audit_log_level="fileAccessAuditLogLevel",
    file_share_access_audit_log_level="fileShareAccessAuditLogLevel",

    # the properties below are optional
    audit_log_destination="auditLogDestination"
)

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 Firehouse 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.

Link

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

Return type

Optional[str]

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.

Link

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

Return type

str

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.

Link

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

Return type

str

ClientConfigurationsProperty

class CfnFileSystem.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.

Link

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

client_configurations_property = fsx.CfnFileSystem.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.

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[List[str]]

DiskIopsConfigurationProperty

class CfnFileSystem.DiskIopsConfigurationProperty(*, iops=None, mode=None)

Bases: object

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

The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).

Parameters
  • iops (Union[int, float, None]) – The total number of SSD IOPS provisioned for the file system.

  • mode (Optional[str]) – Specifies whether the number of IOPS for the file system is using the system default ( AUTOMATIC ) or was provisioned by the customer ( USER_PROVISIONED ).

Link

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

disk_iops_configuration_property = fsx.CfnFileSystem.DiskIopsConfigurationProperty(
    iops=123,
    mode="mode"
)

Attributes

iops

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

Link

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

Return type

Union[int, float, None]

mode

Specifies whether the number of IOPS for the file system is using the system default ( AUTOMATIC ) or was provisioned by the customer ( USER_PROVISIONED ).

Link

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

Return type

Optional[str]

LustreConfigurationProperty

class CfnFileSystem.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, deployment_type=None, drive_cache_type=None, export_path=None, imported_file_chunk_size=None, import_path=None, per_unit_storage_throughput=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) Available with Scratch and Persistent_1 deployment types. 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 using the Persistent_2 deployment type.

  • 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]) – 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. Only valid for use with PERSISTENT_1 deployment types.

  • 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 .

  • 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 SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). 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 File system deployment options for FSx for Lustre 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html) 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 .

  • export_path (Optional[str]) – (Optional) Available with Scratch and Persistent_1 deployment types. 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 using the Persistent_2 deployment type.

  • 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 using the Persistent_2 deployment type.

  • 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 using the 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 file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file 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.

  • weekly_maintenance_start_time (Optional[str]) – A recurring weekly time, in the format D:HH:MM . D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday.

Link

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.
import aws_cdk.aws_fsx as fsx

lustre_configuration_property = fsx.CfnFileSystem.LustreConfigurationProperty(
    auto_import_policy="autoImportPolicy",
    automatic_backup_retention_days=123,
    copy_tags_to_backups=False,
    daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
    data_compression_type="dataCompressionType",
    deployment_type="deploymentType",
    drive_cache_type="driveCacheType",
    export_path="exportPath",
    imported_file_chunk_size=123,
    import_path="importPath",
    per_unit_storage_throughput=123,
    weekly_maintenance_start_time="weeklyMaintenanceStartTime"
)

Attributes

auto_import_policy

(Optional) Available with Scratch and Persistent_1 deployment types.

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 using the ``Persistent_2`` deployment type.
Link

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

Return type

Optional[str]

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 .

Link

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

Return type

Union[int, float, None]

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. Only valid for use with PERSISTENT_1 deployment types.

Link

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

Return type

Union[bool, IResolvable, None]

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.

Link

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

Return type

Optional[str]

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 .

Link

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

Return type

Optional[str]

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 SSD storage, and offers higher PerUnitStorageThroughput (up to 1000 MB/s/TiB). 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 File system deployment options for FSx for Lustre 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](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/data- protection.html) 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 )

Link

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

Return type

Optional[str]

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 .

Link

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

Return type

Optional[str]

export_path

(Optional) Available with Scratch and Persistent_1 deployment types.

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 using the ``Persistent_2`` deployment type.
Link

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

Return type

Optional[str]

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 using the ``Persistent_2`` deployment type.
Link

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

Return type

Optional[str]

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 using the ``Persistent_2`` deployment type.
Link

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

Return type

Union[int, float, None]

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 file system storage capacity (TiB) by the PerUnitStorageThroughput (MB/s/TiB). For a 2.4-TiB file system, provisioning 50 MB/s/TiB of PerUnitStorageThroughput yields 120 MB/s of file 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.

Link

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

Return type

Union[int, float, None]

weekly_maintenance_start_time

A recurring weekly time, in the format D:HH:MM .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

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

Link

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

Return type

Optional[str]

NfsExportsProperty

class CfnFileSystem.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.

Link

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

nfs_exports_property = fsx.CfnFileSystem.NfsExportsProperty(
    client_configurations=[fsx.CfnFileSystem.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.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, ClientConfigurationsProperty]], None]

OntapConfigurationProperty

class CfnFileSystem.OntapConfigurationProperty(*, deployment_type, automatic_backup_retention_days=None, daily_automatic_backup_start_time=None, disk_iops_configuration=None, endpoint_ip_address_range=None, fsx_admin_password=None, preferred_subnet_id=None, route_table_ids=None, throughput_capacity=None, weekly_maintenance_start_time=None)

Bases: object

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

Parameters
  • deployment_type (str) – Specifies the FSx for ONTAP file system deployment type to use in creating the file system. - MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. - SINGLE_AZ_1 - A file system configured for Single-AZ redundancy. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to Choosing a file system deployment type .

  • 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 .

  • 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.

  • 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 IP address range in which the endpoints to access your file system will be created. By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range. .. epigraph:: The Endpoint IP address range you select for your file system must exist outside the VPC’s CIDR range and must be at least /30 or larger.

  • 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.

  • 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.

  • route_table_ids (Optional[Sequence[str]]) – (Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your file system’s endpoints will be created. You should specify all 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]) – Sets the throughput capacity for the file system that you’re creating. Valid values are 128, 256, 512, 1024, and 2048 MBps.

  • weekly_maintenance_start_time (Optional[str]) –

    A recurring weekly time, in the format D:HH:MM . D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday.

Link

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.
import aws_cdk.aws_fsx as fsx

ontap_configuration_property = fsx.CfnFileSystem.OntapConfigurationProperty(
    deployment_type="deploymentType",

    # the properties below are optional
    automatic_backup_retention_days=123,
    daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
    disk_iops_configuration=fsx.CfnFileSystem.DiskIopsConfigurationProperty(
        iops=123,
        mode="mode"
    ),
    endpoint_ip_address_range="endpointIpAddressRange",
    fsx_admin_password="fsxAdminPassword",
    preferred_subnet_id="preferredSubnetId",
    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 0 .

Link

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

Return type

Union[int, float, None]

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.

Link

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

Return type

Optional[str]

deployment_type

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

  • MULTI_AZ_1 - (Default) A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability.

  • SINGLE_AZ_1 - A file system configured for Single-AZ redundancy.

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

Link

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

Return type

str

disk_iops_configuration

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

Link

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

Return type

Union[IResolvable, DiskIopsConfigurationProperty, None]

endpoint_ip_address_range

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

By default, Amazon FSx selects an unused IP address range for you from the 198.19.* range. .. epigraph:

The Endpoint IP address range you select for your file system must exist outside the VPC's CIDR range and must be at least /30 or larger.
Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[str]

route_table_ids

(Multi-AZ only) Specifies the virtual private cloud (VPC) route tables in which your file system’s endpoints will be created.

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

Link

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

Return type

Optional[List[str]]

throughput_capacity

Sets the throughput capacity for the file system that you’re creating.

Valid values are 128, 256, 512, 1024, and 2048 MBps.

Link

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

Return type

Union[int, float, None]

weekly_maintenance_start_time

A recurring weekly time, in the format D:HH:MM .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

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

Link

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

Return type

Optional[str]

OpenZFSConfigurationProperty

class CfnFileSystem.OpenZFSConfigurationProperty(*, deployment_type, automatic_backup_retention_days=None, copy_tags_to_backups=None, copy_tags_to_volumes=None, daily_automatic_backup_start_time=None, disk_iops_configuration=None, options=None, root_volume_configuration=None, throughput_capacity=None, weekly_maintenance_start_time=None)

Bases: object

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

Parameters
  • deployment_type (str) – Specifies the file system deployment type. Amazon FSx for OpenZFS supports SINGLE_AZ_1 . SINGLE_AZ_1 deployment type is configured for redundancy within a single Availability Zone.

  • 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]) – 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 volume should be copied to snapshots. 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.

  • 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.

  • 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 or Amazon FSx for OpenZFS file system. The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).

  • 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.

  • 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.

  • throughput_capacity (Union[int, float, None]) – Specifies the throughput of an Amazon FSx for OpenZFS file system, measured in megabytes per second (MB/s). Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. You pay for additional throughput capacity that you provision.

  • weekly_maintenance_start_time (Optional[str]) –

    A recurring weekly time, in the format D:HH:MM . D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday.

Link

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.
import aws_cdk.aws_fsx as fsx

open_zFSConfiguration_property = fsx.CfnFileSystem.OpenZFSConfigurationProperty(
    deployment_type="deploymentType",

    # the properties below are optional
    automatic_backup_retention_days=123,
    copy_tags_to_backups=False,
    copy_tags_to_volumes=False,
    daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
    disk_iops_configuration=fsx.CfnFileSystem.DiskIopsConfigurationProperty(
        iops=123,
        mode="mode"
    ),
    options=["options"],
    root_volume_configuration=fsx.CfnFileSystem.RootVolumeConfigurationProperty(
        copy_tags_to_snapshots=False,
        data_compression_type="dataCompressionType",
        nfs_exports=[fsx.CfnFileSystem.NfsExportsProperty(
            client_configurations=[fsx.CfnFileSystem.ClientConfigurationsProperty(
                clients="clients",
                options=["options"]
            )]
        )],
        read_only=False,
        record_size_ki_b=123,
        user_and_group_quotas=[fsx.CfnFileSystem.UserAndGroupQuotasProperty(
            id=123,
            storage_capacity_quota_gi_b=123,
            type="type"
        )]
    ),
    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 0 .

Link

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

Return type

Union[int, float, None]

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.

Link

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

Return type

Union[bool, IResolvable, None]

copy_tags_to_volumes

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

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.

Link

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

Return type

Union[bool, IResolvable, None]

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.

Link

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

Return type

Optional[str]

deployment_type

Specifies the file system deployment type.

Amazon FSx for OpenZFS supports SINGLE_AZ_1 . SINGLE_AZ_1 deployment type is configured for redundancy within a single Availability Zone.

Link

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

Return type

str

disk_iops_configuration

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

The default is 3 IOPS per GB of storage capacity, but you can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how the amount was provisioned (by the customer or by the system).

Link

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

Return type

Union[IResolvable, DiskIopsConfigurationProperty, None]

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.

Link

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

Return type

Optional[List[str]]

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.

Link

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

Return type

Union[IResolvable, RootVolumeConfigurationProperty, None]

throughput_capacity

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

Valid values are 64, 128, 256, 512, 1024, 2048, 3072, or 4096 MB/s. You pay for additional throughput capacity that you provision.

Link

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

Return type

Union[int, float, None]

weekly_maintenance_start_time

A recurring weekly time, in the format D:HH:MM .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

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

Link

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

Return type

Optional[str]

RootVolumeConfigurationProperty

class CfnFileSystem.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.

Link

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

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

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.

Link

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

Return type

Union[bool, IResolvable, None]

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.

Link

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

Return type

Optional[str]

nfs_exports

The configuration object for mounting a file system.

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, NfsExportsProperty]], None]

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.

Link

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

Return type

Union[bool, IResolvable, None]

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 .

Link

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

Return type

Union[int, float, None]

user_and_group_quotas

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

Link

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

Return type

Union[IResolvable, List[Union[IResolvable, UserAndGroupQuotasProperty]], None]

SelfManagedActiveDirectoryConfigurationProperty

class CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty(*, dns_ips=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 ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory.

For more information, see Using Amazon FSx with your self-managed Microsoft Active Directory or Managing 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_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.

Link

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

self_managed_active_directory_configuration_property = fsx.CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty(
    dns_ips=["dnsIps"],
    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.

Link

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

Return type

Optional[List[str]]

domain_name

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

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[str]

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.
Link

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

Return type

Optional[str]

password

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

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[str]

UserAndGroupQuotasProperty

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

Bases: object

The configuration for how much storage a user or group can use on the volume.

Parameters
  • id (Union[int, float, None]) – The ID of the user or group.

  • storage_capacity_quota_gib (Union[int, float, None]) – The amount of storage that the user or group can use in gibibytes (GiB).

  • type (Optional[str]) – A value that specifies whether the quota applies to a user or group.

Link

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

user_and_group_quotas_property = fsx.CfnFileSystem.UserAndGroupQuotasProperty(
    id=123,
    storage_capacity_quota_gi_b=123,
    type="type"
)

Attributes

id

The ID of the user or group.

Link

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

Return type

Union[int, float, None]

storage_capacity_quota_gib

The amount of storage that the user or group can use in gibibytes (GiB).

Link

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

Return type

Union[int, float, None]

type

A value that specifies whether the quota applies to a user or group.

Link

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

Return type

Optional[str]

WindowsConfigurationProperty

class CfnFileSystem.WindowsConfigurationProperty(*, throughput_capacity, 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, preferred_subnet_id=None, self_managed_active_directory_configuration=None, weekly_maintenance_start_time=None)

Bases: object

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

Parameters
  • throughput_capacity (Union[int, float]) – 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).

  • 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 0 .

  • 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 .

  • 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 ONTAP storage virtual machine (SVM) to a self-managed (including on-premises) Microsoft Active Directory (AD) directory. For more information, see Using Amazon FSx with your self-managed Microsoft Active Directory or Managing SVMs .

  • weekly_maintenance_start_time (Optional[str]) –

    A recurring weekly time, in the format D:HH:MM . D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia . HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour. For example, 1:05:00 specifies maintenance at 5 AM Monday.

Link

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.
import aws_cdk.aws_fsx as fsx

windows_configuration_property = fsx.CfnFileSystem.WindowsConfigurationProperty(
    throughput_capacity=123,

    # the properties below are optional
    active_directory_id="activeDirectoryId",
    aliases=["aliases"],
    audit_log_configuration=fsx.CfnFileSystem.AuditLogConfigurationProperty(
        file_access_audit_log_level="fileAccessAuditLogLevel",
        file_share_access_audit_log_level="fileShareAccessAuditLogLevel",

        # the properties below are optional
        audit_log_destination="auditLogDestination"
    ),
    automatic_backup_retention_days=123,
    copy_tags_to_backups=False,
    daily_automatic_backup_start_time="dailyAutomaticBackupStartTime",
    deployment_type="deploymentType",
    preferred_subnet_id="preferredSubnetId",
    self_managed_active_directory_configuration=fsx.CfnFileSystem.SelfManagedActiveDirectoryConfigurationProperty(
        dns_ips=["dnsIps"],
        domain_name="domainName",
        file_system_administrators_group="fileSystemAdministratorsGroup",
        organizational_unit_distinguished_name="organizationalUnitDistinguishedName",
        password="password",
        user_name="userName"
    ),
    weekly_maintenance_start_time="weeklyMaintenanceStartTime"
)

Attributes

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.

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[List[str]]

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.

Link

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

Return type

Union[IResolvable, AuditLogConfigurationProperty, None]

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 .

Link

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

Return type

Union[int, float, None]

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.

Link

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

Return type

Union[bool, IResolvable, None]

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.

Link

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

Return type

Optional[str]

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 .

Link

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

Return type

Optional[str]

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.

Link

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

Return type

Optional[str]

self_managed_active_directory_configuration

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

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

Link

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

Return type

Union[IResolvable, SelfManagedActiveDirectoryConfigurationProperty, None]

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).

Link

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

Return type

Union[int, float]

weekly_maintenance_start_time

A recurring weekly time, in the format D:HH:MM .

D is the day of the week, for which 1 represents Monday and 7 represents Sunday. For further details, see the ISO-8601 spec as described on Wikipedia .

HH is the zero-padded hour of the day (0-23), and MM is the zero-padded minute of the hour.

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

Link

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

Return type

Optional[str]