--- title: Getting Started with Datadog description: Datadog, the leading service for cloud-scale monitoring. breadcrumbs: Docs > Infrastructure > Datadog Resource Catalog --- # aws_fsx_file_system{% #aws_fsx_file_system %} ## `account_id`{% #account_id %} **Type**: `STRING` ## `creation_time`{% #creation_time %} **Type**: `TIMESTAMP`**Provider name**: `CreationTime`**Description**: The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time. ## `dns_name`{% #dns_name %} **Type**: `STRING`**Provider name**: `DNSName`**Description**: The Domain Name System (DNS) name for the file system. ## `failure_details`{% #failure_details %} **Type**: `STRUCT`**Provider name**: `FailureDetails` - `message`**Type**: `STRING`**Provider name**: `Message`**Description**: A message describing any failures that occurred. ## `file_system_id`{% #file_system_id %} **Type**: `STRING`**Provider name**: `FileSystemId`**Description**: The system-generated, unique 17-digit ID of the file system. ## `file_system_type`{% #file_system_type %} **Type**: `STRING`**Provider name**: `FileSystemType`**Description**: The type of Amazon FSx file system, which can be `LUSTRE`, `WINDOWS`, `ONTAP`, or `OPENZFS`. ## `file_system_type_version`{% #file_system_type_version %} **Type**: `STRING`**Provider name**: `FileSystemTypeVersion`**Description**: The Lustre version of the Amazon FSx for Lustre file system, which can be `2.10`, `2.12`, or `2.15`. ## `kms_key_id`{% #kms_key_id %} **Type**: `STRING`**Provider name**: `KmsKeyId`**Description**: The ID of the Key Management Service (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 KMS key for your account. - Amazon FSx for NetApp ONTAP - Amazon FSx for OpenZFS - Amazon FSx for Windows File Server ## `lifecycle`{% #lifecycle %} **Type**: `STRING`**Provider name**: `Lifecycle`**Description**: The lifecycle status of the file system. The following are the possible values and what they mean: - `AVAILABLE` - The file system is in a healthy state, and is reachable and available for use. - `CREATING` - Amazon FSx is creating the new file system. - `DELETING` - Amazon FSx is deleting an existing file system. - `FAILED` - An existing file system has experienced an unrecoverable failure. When creating a new file system, Amazon FSx was unable to create the file system. - `MISCONFIGURED` - The file system is in a failed but recoverable state. - `MISCONFIGURED_UNAVAILABLE` - (Amazon FSx for Windows File Server only) The file system is currently unavailable due to a change in your Active Directory configuration. - `UPDATING` - The file system is undergoing a customer-initiated update. ## `lustre_configuration`{% #lustre_configuration %} **Type**: `STRUCT`**Provider name**: `LustreConfiguration` - `automatic_backup_retention_days`**Type**: `INT32`**Provider name**: `AutomaticBackupRetentionDays` - `copy_tags_to_backups`**Type**: `BOOLEAN`**Provider name**: `CopyTagsToBackups`**Description**: A boolean flag indicating whether tags on the file system are copied to backups. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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. (Default = false) - `daily_automatic_backup_start_time`**Type**: `STRING`**Provider name**: `DailyAutomaticBackupStartTime` - `data_compression_type`**Type**: `STRING`**Provider name**: `DataCompressionType`**Description**: The data compression configuration for the file system. `DataCompressionType` can have the following values: - `NONE` - Data compression is turned off for the file system. - `LZ4` - Data compression is turned on with the LZ4 algorithm. For more information, see [Lustre data compression](https://docs.aws.amazon.com/fsx/latest/LustreGuide/data-compression.html). - `data_repository_configuration`**Type**: `STRUCT`**Provider name**: `DataRepositoryConfiguration` - `auto_import_policy`**Type**: `STRING`**Provider name**: `AutoImportPolicy`**Description**: Describes the file system's linked S3 data repository's `AutoImportPolicy`. The AutoImportPolicy configures 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. - `export_path`**Type**: `STRING`**Provider name**: `ExportPath`**Description**: The export path to the Amazon S3 bucket (and prefix) that you are using to store new and changed Lustre file system files in S3. - `failure_details`**Type**: `STRUCT`**Provider name**: `FailureDetails` - `message`**Type**: `STRING`**Provider name**: `Message` - `import_path`**Type**: `STRING`**Provider name**: `ImportPath`**Description**: The import path to the Amazon S3 bucket (and optional prefix) that you're using as the data repository for your FSx for Lustre file system, for example `s3://import-bucket/optional-prefix`. If a prefix is specified after the Amazon S3 bucket name, only object keys with that prefix are loaded into the file system. - `imported_file_chunk_size`**Type**: `INT32`**Provider name**: `ImportedFileChunkSize`**Description**: 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. - `lifecycle`**Type**: `STRING`**Provider name**: `Lifecycle`**Description**: Describes the state of the file system's S3 durable data repository, if it is configured with an S3 repository. The lifecycle can have the following values: - `CREATING` - The data repository configuration between the FSx file system and the linked S3 data repository is being created. The data repository is unavailable. - `AVAILABLE` - The data repository is available for use. - `MISCONFIGURED` - Amazon FSx cannot automatically import updates from the S3 bucket until the data repository configuration is corrected. For more information, see [Troubleshooting a Misconfigured linked S3 bucket](https://docs.aws.amazon.com/fsx/latest/LustreGuide/troubleshooting.html#troubleshooting-misconfigured-data-repository). - `UPDATING` - The data repository is undergoing a customer initiated update and availability may be impacted. - `FAILED` - The data repository is in a terminal state that cannot be recovered. - `deployment_type`**Type**: `STRING`**Provider name**: `DeploymentType`**Description**: The deployment type of the FSx for Lustre file system. Scratch deployment type is designed for temporary storage and shorter-term processing of data. `SCRATCH_1` and `SCRATCH_2` deployment types are best suited for 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`. The `PERSISTENT_1` and `PERSISTENT_2` deployment type is used for longer-term storage and workloads and encryption of data in transit. `PERSISTENT_2` offers higher `PerUnitStorageThroughput` (up to 1000 MB/s/TiB) along with a lower minimum storage capacity requirement (600 GiB). To learn more about FSx for Lustre deployment types, see [FSx for Lustre deployment options](https://docs.aws.amazon.com/fsx/latest/LustreGuide/lustre-deployment-types.html). The default is `SCRATCH_1`. - `drive_cache_type`**Type**: `STRING`**Provider name**: `DriveCacheType`**Description**: The type of drive cache used by `PERSISTENT_1` file systems that are provisioned with HDD storage devices. This parameter is required when `StorageType` is HDD. When set to `READ` the file system has an SSD storage cache that is sized to 20% of the file system's storage capacity. This improves the performance for frequently accessed files by caching up to 20% of the total storage capacity. This parameter is required when `StorageType` is set to HDD. - `log_configuration`**Type**: `STRUCT`**Provider name**: `LogConfiguration`**Description**: The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs. - `destination`**Type**: `STRING`**Provider name**: `Destination`**Description**: The Amazon Resource Name (ARN) that specifies the destination of the logs. The destination can be any Amazon CloudWatch Logs log group ARN. The destination ARN must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. - `level`**Type**: `STRING`**Provider name**: `Level`**Description**: The data repository events that are logged by Amazon FSx. - `WARN_ONLY` - only warning events are logged. - `ERROR_ONLY` - only error events are logged. - `WARN_ERROR` - both warning events and error events are logged. - `DISABLED` - logging of data repository events is turned off. Note that Amazon File Cache uses a default setting of `WARN_ERROR`, which can't be changed. - `metadata_configuration`**Type**: `STRUCT`**Provider name**: `MetadataConfiguration`**Description**: The Lustre metadata performance configuration for an Amazon FSx for Lustre file system using a `PERSISTENT_2` deployment type. - `iops`**Type**: `INT32`**Provider name**: `Iops`**Description**: The number of Metadata IOPS provisioned for the file system. Valid values are `1500`, `3000`, `6000`, `12000`, and multiples of `12000` up to a maximum of `192000`. - `mode`**Type**: `STRING`**Provider name**: `Mode`**Description**: The metadata configuration mode for provisioning Metadata IOPS for the file system. - In AUTOMATIC mode, FSx for Lustre automatically provisions and scales the number of Metadata IOPS on your file system based on your file system storage capacity. - In USER_PROVISIONED mode, you can choose to specify the number of Metadata IOPS to provision for your file system. - `mount_name`**Type**: `STRING`**Provider name**: `MountName`**Description**: You use the `MountName` value when mounting the file system. For the `SCRATCH_1` deployment type, this value is always "`fsx`". For `SCRATCH_2`, `PERSISTENT_1`, and `PERSISTENT_2` deployment types, this value is a string that is unique within an Amazon Web Services Region. - `per_unit_storage_throughput`**Type**: `INT32`**Provider name**: `PerUnitStorageThroughput`**Description**: Per unit storage throughput represents the megabytes per second of read or write throughput per 1 tebibyte of storage provisioned. File system throughput capacity is equal to Storage capacity (TiB) * PerUnitStorageThroughput (MB/s/TiB). This option is only valid for `PERSISTENT_1` and `PERSISTENT_2` deployment types. Valid values: - For `PERSISTENT_1` SSD storage: 50, 100, 200. - For `PERSISTENT_1` HDD storage: 12, 40. - For `PERSISTENT_2` SSD storage: 125, 250, 500, 1000. - `root_squash_configuration`**Type**: `STRUCT`**Provider name**: `RootSquashConfiguration`**Description**: The Lustre root squash configuration for an Amazon FSx for Lustre file system. When enabled, root squash restricts root-level access from clients that try to access your file system as a root user. - `no_squash_nids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `NoSquashNids`**Description**: When root squash is enabled, you can optionally specify an array of NIDs of clients for which root squash does not apply. A client NID is a Lustre Network Identifier used to uniquely identify a client. You can specify the NID as either a single address or a range of addresses: - A single address is described in standard Lustre NID format by specifying the client's IP address followed by the Lustre network ID (for example, `10.0.1.6@tcp`). - An address range is described using a dash to separate the range (for example, `10.0.[2-10].[1-255]@tcp`). - `root_squash`**Type**: `STRING`**Provider name**: `RootSquash`**Description**: You enable root squash by setting a user ID (UID) and group ID (GID) for the file system in the format `UID:GID` (for example, `365534:65534`). The UID and GID values can range from `0` to `4294967294`: - A non-zero value for UID and GID enables root squash. The UID and GID values can be different, but each must be a non-zero value. - A value of `0` (zero) for UID and GID indicates root, and therefore disables root squash. When root squash is enabled, the user ID and group ID of a root user accessing the file system are re-mapped to the UID and GID you provide. - `weekly_maintenance_start_time`**Type**: `STRING`**Provider name**: `WeeklyMaintenanceStartTime`**Description**: The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. Here, `d` is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday. ## `network_interface_ids`{% #network_interface_ids %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `NetworkInterfaceIds`**Description**: The IDs of the elastic network interfaces from which a specific file system is accessible. The elastic network interface is automatically created in the same virtual private cloud (VPC) that the Amazon FSx file system was created in. For more information, see [Elastic Network Interfaces](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-eni.html) in the Amazon EC2 User Guide. For an Amazon FSx for Windows File Server file system, you can have one network interface ID. For an Amazon FSx for Lustre file system, you can have more than one. ## `ontap_configuration`{% #ontap_configuration %} **Type**: `STRUCT`**Provider name**: `OntapConfiguration`**Description**: The configuration for this Amazon FSx for NetApp ONTAP file system. - `automatic_backup_retention_days`**Type**: `INT32`**Provider name**: `AutomaticBackupRetentionDays` - `daily_automatic_backup_start_time`**Type**: `STRING`**Provider name**: `DailyAutomaticBackupStartTime` - `deployment_type`**Type**: `STRING`**Provider name**: `DeploymentType`**Description**: Specifies the FSx for ONTAP file system deployment type in use in the file system. - `MULTI_AZ_1` - A high availability file system configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability. This is a first-generation FSx for ONTAP file system. - `MULTI_AZ_2` - A high availability file system configured for Multi-AZ redundancy to tolerate temporary AZ unavailability. This is a second-generation FSx for ONTAP file system. - `SINGLE_AZ_1` - A file system configured for Single-AZ redundancy. This is a first-generation FSx for ONTAP file system. - `SINGLE_AZ_2` - A file system configured with multiple high-availability (HA) pairs for Single-AZ redundancy. This is a second-generation FSx for ONTAP file system. For information about the use cases for Multi-AZ and Single-AZ deployments, refer to [Choosing Multi-AZ or Single-AZ file system deployment](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/high-availability-multiAZ.html). - `disk_iops_configuration`**Type**: `STRUCT`**Provider name**: `DiskIopsConfiguration`**Description**: The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode. - `iops`**Type**: `INT64`**Provider name**: `Iops`**Description**: The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of `HAPairs` and `StorageCapacity`. The minimum value is calculated as `StorageCapacity` * 3 * `HAPairs` (3 IOPS per GB of `StorageCapacity`). The maximum value is calculated as 200,000 * `HAPairs`. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of `Iops` is outside of the minimum or maximum values. - `mode`**Type**: `STRING`**Provider name**: `Mode`**Description**: Specifies whether the file system is using the `AUTOMATIC` setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a `USER_PROVISIONED` value. - `endpoint_ip_address_range`**Type**: `STRING`**Provider name**: `EndpointIpAddressRange`**Description**: (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API, Amazon FSx selects an unused IP address range for you from the 198.19.* range. By default in the Amazon FSx console, Amazon FSx chooses the last 64 IP addresses from the VPC's primary CIDR range to use as the endpoint IP address range for the file system. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. - `endpoints`**Type**: `STRUCT`**Provider name**: `Endpoints`**Description**: The `Management` and `Intercluster` endpoints that are used to access data or to manage the file system using the NetApp ONTAP CLI, REST API, or NetApp SnapMirror. - `intercluster`**Type**: `STRUCT`**Provider name**: `Intercluster`**Description**: An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems. - `dns_name`**Type**: `STRING`**Provider name**: `DNSName` - `ip_addresses`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `IpAddresses`**Description**: IP addresses of the file system endpoint. - `management`**Type**: `STRUCT`**Provider name**: `Management`**Description**: An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API. - `dns_name`**Type**: `STRING`**Provider name**: `DNSName` - `ip_addresses`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `IpAddresses`**Description**: IP addresses of the file system endpoint. - `fsx_admin_password`**Type**: `STRING`**Provider name**: `FsxAdminPassword`**Description**: You can use the `fsxadmin` user account to access the NetApp ONTAP CLI and REST API. The password value is always redacted in the response. - `ha_pairs`**Type**: `INT32`**Provider name**: `HAPairs`**Description**: Specifies how many high-availability (HA) file server pairs the file system will have. The default value is 1. The value of this property affects the values of `StorageCapacity`, `Iops`, and `ThroughputCapacity`. For more information, see [High-availability (HA) pairs](https://docs.aws.amazon.com/fsx/latest/ONTAPGuide/HA-pairs.html) in the FSx for ONTAP user guide. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of `HAPairs` is less than 1 or greater than 12. - The value of `HAPairs` is greater than 1 and the value of `DeploymentType` is `SINGLE_AZ_1`, `MULTI_AZ_1`, or `MULTI_AZ_2`. - `preferred_subnet_id`**Type**: `STRING`**Provider name**: `PreferredSubnetId` - `route_table_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `RouteTableIds`**Description**: (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. - `throughput_capacity`**Type**: `INT32`**Provider name**: `ThroughputCapacity` - `throughput_capacity_per_ha_pair`**Type**: `INT32`**Provider name**: `ThroughputCapacityPerHAPair`**Description**: Use to choose the throughput capacity per HA pair. When the value of `HAPairs` is equal to 1, the value of `ThroughputCapacityPerHAPair` is the total throughput for the file system. This field and `ThroughputCapacity` cannot be defined in the same API call, but one is required. This field and `ThroughputCapacity` are the same for file systems with one HA pair. - For `SINGLE_AZ_1` and `MULTI_AZ_1` file systems, valid values are 128, 256, 512, 1024, 2048, or 4096 MBps. - For `SINGLE_AZ_2`, valid values are 1536, 3072, or 6144 MBps. - For `MULTI_AZ_2`, valid values are 384, 768, 1536, 3072, or 6144 MBps. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions: - The value of `ThroughputCapacity` and `ThroughputCapacityPerHAPair` are not the same value. - The value of deployment type is `SINGLE_AZ_2` and `ThroughputCapacity` / `ThroughputCapacityPerHAPair` is not a valid HA pair (a value between 1 and 12). - The value of `ThroughputCapacityPerHAPair` is not a valid value. - `weekly_maintenance_start_time`**Type**: `STRING`**Provider name**: `WeeklyMaintenanceStartTime` ## `open_zfs_configuration`{% #open_zfs_configuration %} **Type**: `STRUCT`**Provider name**: `OpenZFSConfiguration`**Description**: The configuration for this Amazon FSx for OpenZFS file system. - `automatic_backup_retention_days`**Type**: `INT32`**Provider name**: `AutomaticBackupRetentionDays` - `copy_tags_to_backups`**Type**: `BOOLEAN`**Provider name**: `CopyTagsToBackups`**Description**: A Boolean value indicating whether tags on the file system should be copied to backups. If it's set to `true`, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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`**Type**: `BOOLEAN`**Provider name**: `CopyTagsToVolumes`**Description**: 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`**Type**: `STRING`**Provider name**: `DailyAutomaticBackupStartTime` - `deployment_type`**Type**: `STRING`**Provider name**: `DeploymentType`**Description**: Specifies the file-system deployment type. Amazon FSx for OpenZFS supports `MULTI_AZ_1`, `SINGLE_AZ_HA_2`, `SINGLE_AZ_HA_1`, `SINGLE_AZ_2`, and `SINGLE_AZ_1`. - `disk_iops_configuration`**Type**: `STRUCT`**Provider name**: `DiskIopsConfiguration` - `iops`**Type**: `INT64`**Provider name**: `Iops`**Description**: The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of `HAPairs` and `StorageCapacity`. The minimum value is calculated as `StorageCapacity` * 3 * `HAPairs` (3 IOPS per GB of `StorageCapacity`). The maximum value is calculated as 200,000 * `HAPairs`. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of `Iops` is outside of the minimum or maximum values. - `mode`**Type**: `STRING`**Provider name**: `Mode`**Description**: Specifies whether the file system is using the `AUTOMATIC` setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a `USER_PROVISIONED` value. - `endpoint_ip_address`**Type**: `STRING`**Provider name**: `EndpointIpAddress`**Description**: The IP address of the endpoint that is used to access data or to manage the file system. - `endpoint_ip_address_range`**Type**: `STRING`**Provider name**: `EndpointIpAddressRange`**Description**: (Multi-AZ only) Specifies the IP address range in which the endpoints to access your file system will be created. By default in the Amazon FSx API and Amazon FSx console, Amazon FSx selects an available /28 IP address range for you from one of the VPC's CIDR ranges. You can have overlapping endpoint IP addresses for file systems deployed in the same VPC/route tables. - `preferred_subnet_id`**Type**: `STRING`**Provider name**: `PreferredSubnetId`**Description**: Required when `DeploymentType` is set to `MULTI_AZ_1`. This specifies the subnet in which you want the preferred file server to be located. - `root_volume_id`**Type**: `STRING`**Provider name**: `RootVolumeId`**Description**: The ID of the root volume of the OpenZFS file system. - `route_table_ids`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `RouteTableIds`**Description**: (Multi-AZ only) The VPC route tables in which your file system's endpoints are created. - `throughput_capacity`**Type**: `INT32`**Provider name**: `ThroughputCapacity`**Description**: The throughput of an Amazon FSx file system, measured in megabytes per second (MBps). - `weekly_maintenance_start_time`**Type**: `STRING`**Provider name**: `WeeklyMaintenanceStartTime` ## `owner_id`{% #owner_id %} **Type**: `STRING`**Provider name**: `OwnerId`**Description**: The Amazon Web Services account that created the file system. If the file system was created by a user in IAM Identity Center, the Amazon Web Services account to which the IAM user belongs is the owner. ## `resource_arn`{% #resource_arn %} **Type**: `STRING`**Provider name**: `ResourceARN`**Description**: The Amazon Resource Name (ARN) of the file system resource. ## `storage_capacity`{% #storage_capacity %} **Type**: `INT32`**Provider name**: `StorageCapacity`**Description**: The storage capacity of the file system in gibibytes (GiB). Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of `StorageCapacity` is outside of the minimum or maximum values. ## `storage_type`{% #storage_type %} **Type**: `STRING`**Provider name**: `StorageType`**Description**: The type of storage the file system is using. If set to `SSD`, the file system uses solid state drive storage. If set to `HDD`, the file system uses hard disk drive storage. ## `subnet_ids`{% #subnet_ids %} **Type**: `UNORDERED_LIST_STRING`**Provider name**: `SubnetIds`**Description**: Specifies the IDs of the subnets that the file system is accessible from. For the Amazon FSx Windows and ONTAP `MULTI_AZ_1` file system deployment type, there are two subnet IDs, one for the preferred file server and one for the standby file server. The preferred file server subnet identified in the `PreferredSubnetID` property. All other file systems have only one subnet ID. For FSx for Lustre file systems, and Single-AZ Windows file systems, this is the ID of the subnet that contains the file system's endpoint. For `MULTI_AZ_1` Windows and ONTAP file systems, the file system endpoint is available in the `PreferredSubnetID`. ## `tags`{% #tags %} **Type**: `UNORDERED_LIST_STRING` ## `vpc_id`{% #vpc_id %} **Type**: `STRING`**Provider name**: `VpcId`**Description**: The ID of the primary virtual private cloud (VPC) for the file system. ## `windows_configuration`{% #windows_configuration %} **Type**: `STRUCT`**Provider name**: `WindowsConfiguration`**Description**: The configuration for this Amazon FSx for Windows File Server file system. - `active_directory_id`**Type**: `STRING`**Provider name**: `ActiveDirectoryId`**Description**: The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to. - `aliases`**Type**: `UNORDERED_LIST_STRUCT`**Provider name**: `Aliases` - `lifecycle`**Type**: `STRING`**Provider name**: `Lifecycle`**Description**: Describes the state of the DNS alias. - AVAILABLE - The DNS alias is associated with an Amazon FSx file system. - CREATING - Amazon FSx is creating the DNS alias and associating it with the file system. - CREATE_FAILED - Amazon FSx was unable to associate the DNS alias with the file system. - DELETING - Amazon FSx is disassociating the DNS alias from the file system and deleting it. - DELETE_FAILED - Amazon FSx was unable to disassociate the DNS alias from the file system. - `name`**Type**: `STRING`**Provider name**: `Name`**Description**: The name of the DNS alias. The 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 names, Amazon FSx stores alphabetic 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`**Type**: `STRUCT`**Provider name**: `AuditLogConfiguration`**Description**: 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. - `audit_log_destination`**Type**: `STRING`**Provider name**: `AuditLogDestination`**Description**: The Amazon Resource Name (ARN) for the destination of the audit logs. The destination can be any Amazon CloudWatch Logs log group ARN or Amazon Kinesis Data Firehose delivery stream ARN. The name of the Amazon CloudWatch Logs log group must begin with the `/aws/fsx` prefix. The name of the Amazon Kinesis Data Firehose delivery stream must begin with the `aws-fsx` prefix. The destination ARN (either CloudWatch Logs log group or Kinesis Data Firehose delivery stream) must be in the same Amazon Web Services partition, Amazon Web Services Region, and Amazon Web Services account as your Amazon FSx file system. - `file_access_audit_log_level`**Type**: `STRING`**Provider name**: `FileAccessAuditLogLevel`**Description**: 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`**Type**: `STRING`**Provider name**: `FileShareAccessAuditLogLevel`**Description**: 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. - `automatic_backup_retention_days`**Type**: `INT32`**Provider name**: `AutomaticBackupRetentionDays`**Description**: The number of days to retain automatic backups. Setting this to 0 disables automatic backups. You can retain automatic backups for a maximum of 90 days. - `copy_tags_to_backups`**Type**: `BOOLEAN`**Provider name**: `CopyTagsToBackups`**Description**: A boolean flag indicating whether tags on the file system should be copied to backups. This value defaults to false. If it's set to true, all tags on the file system are copied to all automatic backups and any user-initiated backups where the user doesn't specify any 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`**Type**: `STRING`**Provider name**: `DailyAutomaticBackupStartTime`**Description**: The preferred time to take daily automatic backups, in the UTC time zone. - `deployment_type`**Type**: `STRING`**Provider name**: `DeploymentType`**Description**: Specifies the file system deployment type, valid values are the following: - `MULTI_AZ_1` - Specifies a high availability file system that is configured for Multi-AZ redundancy to tolerate temporary Availability Zone (AZ) unavailability, and supports SSD and HDD storage. - `SINGLE_AZ_1` - (Default) Specifies a file system that is configured for single AZ redundancy, only supports SSD storage. - `SINGLE_AZ_2` - Latest generation Single AZ file system. Specifies a file system that is configured for single AZ redundancy and supports SSD and HDD storage. For more information, see [Single-AZ and Multi-AZ File Systems](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html). - `disk_iops_configuration`**Type**: `STRUCT`**Provider name**: `DiskIopsConfiguration`**Description**: The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for Windows file system. By default, Amazon FSx automatically provisions 3 IOPS per GiB of storage capacity. You can provision additional IOPS per GiB of storage, up to the maximum limit associated with your chosen throughput capacity. - `iops`**Type**: `INT64`**Provider name**: `Iops`**Description**: The total number of SSD IOPS provisioned for the file system. The minimum and maximum values for this property depend on the value of `HAPairs` and `StorageCapacity`. The minimum value is calculated as `StorageCapacity` * 3 * `HAPairs` (3 IOPS per GB of `StorageCapacity`). The maximum value is calculated as 200,000 * `HAPairs`. Amazon FSx responds with an HTTP status code 400 (Bad Request) if the value of `Iops` is outside of the minimum or maximum values. - `mode`**Type**: `STRING`**Provider name**: `Mode`**Description**: Specifies whether the file system is using the `AUTOMATIC` setting of SSD IOPS of 3 IOPS per GB of storage capacity, or if it using a `USER_PROVISIONED` value. - `maintenance_operations_in_progress`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `MaintenanceOperationsInProgress`**Description**: The list of maintenance operations in progress for this file system. - `preferred_file_server_ip`**Type**: `STRING`**Provider name**: `PreferredFileServerIp`**Description**: For `MULTI_AZ_1` deployment types, the IP address of the primary, or preferred, file server. Use this IP address when mounting the file system on Linux SMB clients or Windows SMB clients that are not joined to a Microsoft Active Directory. Applicable for all Windows file system deployment types. This IP address is temporarily unavailable when the file system is undergoing maintenance. For Linux and Windows SMB clients that are joined to an Active Directory, use the file system's DNSName instead. For more information on mapping and mounting file shares, see [Accessing File Shares](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/accessing-file-shares.html). - `preferred_subnet_id`**Type**: `STRING`**Provider name**: `PreferredSubnetId`**Description**: For `MULTI_AZ_1` deployment types, it specifies the ID of the subnet where the preferred file server is located. Must be one of the two subnet IDs specified in `SubnetIds` property. Amazon FSx serves traffic from this subnet except in the event of a failover to the secondary file server. For `SINGLE_AZ_1` and `SINGLE_AZ_2` deployment types, this value is the same as that for `SubnetIDs`. For more information, see [Availability and durability: Single-AZ and Multi-AZ file systems](https://docs.aws.amazon.com/fsx/latest/WindowsGuide/high-availability-multiAZ.html#single-multi-az-resources). - `remote_administration_endpoint`**Type**: `STRING`**Provider name**: `RemoteAdministrationEndpoint`**Description**: For `MULTI_AZ_1` deployment types, use this endpoint when performing administrative tasks on the file system using Amazon FSx Remote PowerShell. For `SINGLE_AZ_1` and `SINGLE_AZ_2` deployment types, this is the DNS name of the file system. This endpoint is temporarily unavailable when the file system is undergoing maintenance. - `self_managed_active_directory_configuration`**Type**: `STRUCT`**Provider name**: `SelfManagedActiveDirectoryConfiguration` - `dns_ips`**Type**: `UNORDERED_LIST_STRING`**Provider name**: `DnsIps`**Description**: A list of up to three IP addresses of DNS servers or domain controllers in the self-managed AD directory. - `domain_name`**Type**: `STRING`**Provider name**: `DomainName`**Description**: The fully qualified domain name of the self-managed AD directory. - `file_system_administrators_group`**Type**: `STRING`**Provider name**: `FileSystemAdministratorsGroup`**Description**: The name of the domain group whose members have administrative privileges for the FSx file system. - `organizational_unit_distinguished_name`**Type**: `STRING`**Provider name**: `OrganizationalUnitDistinguishedName`**Description**: The fully qualified distinguished name of the organizational unit within the self-managed AD directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined. - `user_name`**Type**: `STRING`**Provider name**: `UserName`**Description**: The user name for the service account on your self-managed AD domain that FSx uses to join to your AD domain. - `throughput_capacity`**Type**: `INT32`**Provider name**: `ThroughputCapacity`**Description**: The throughput of the Amazon FSx file system, measured in megabytes per second. - `weekly_maintenance_start_time`**Type**: `STRING`**Provider name**: `WeeklyMaintenanceStartTime`**Description**: The preferred start time to perform weekly maintenance, formatted d:HH:MM in the UTC time zone. d is the weekday number, from 1 through 7, beginning with Monday and ending with Sunday.