aws_fsx_backup

account_id

Type: STRING

backup_id

Type: STRING
Provider name: BackupId
Description: The ID of the backup.

creation_time

Type: TIMESTAMP
Provider name: CreationTime
Description: The time when a particular backup was created.

directory_information

Type: STRUCT
Provider name: DirectoryInformation
Description: The configuration of the self-managed Microsoft Active Directory directory to which the Windows File Server instance is joined.

• active_directory_id
  Type: STRING
  Provider name: ActiveDirectoryId
  Description: The ID of the Amazon Web Services Managed Microsoft Active Directory instance to which the file system is joined.
  
• domain_name
  Type: STRING
  Provider name: DomainName
  Description: The fully qualified domain name of the self-managed Active Directory directory.
  
• resource_arn
  Type: STRING
  Provider name: ResourceARN
  

failure_details

Type: STRUCT
Provider name: FailureDetails
Description: Details explaining any failures that occurred when creating a backup.

• message
  Type: STRING
  Provider name: Message
  Description: A message describing the backup-creation failure.
  

file_system

Type: STRUCT
Provider name: FileSystem
Description: The metadata of the file system associated with the backup. This metadata is persisted even if the file system is deleted.

• 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
  Type: STRING
  Provider name: DNSName
  Description: The Domain Name System (DNS) name for the file system.
  
• failure_details
  Type: STRUCT
  Provider name: FailureDetails
  
  • message
    Type: STRING
    Provider name: Message
    Description: A message describing any failures that occurred.
    
• file_system_id
  Type: STRING
  Provider name: FileSystemId
  Description: The system-generated, unique 17-digit ID of the file system.
  
• 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
  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
  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
  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
  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.
    
  • 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.
      • 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. 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
  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 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
  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.
    
  • 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 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
  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
  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
  Type: STRING
  Provider name: ResourceARN
  Description: The Amazon Resource Name (ARN) of the file system resource.
  
• 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
  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
  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.
  
• vpc_id
  Type: STRING
  Provider name: VpcId
  Description: The ID of the primary virtual private cloud (VPC) for the file system.
  
• 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.
    
  • 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.
    
  • 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.
    
  • 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.
    

kms_key_id

Type: STRING
Provider name: KmsKeyId
Description: The ID of the Key Management Service (KMS) key used to encrypt the backup of the Amazon FSx file system’s data at rest.

lifecycle

Type: STRING
Provider name: Lifecycle
Description: The lifecycle status of the backup.

• AVAILABLE - The backup is fully available.
• PENDING - For user-initiated backups on Lustre file systems only; Amazon FSx hasn’t started creating the backup.
• CREATING - Amazon FSx is creating the backup.
• TRANSFERRING - For user-initiated backups on Lustre file systems only; Amazon FSx is transferring the backup to Amazon S3.
• COPYING - Amazon FSx is copying the backup.
• DELETED - Amazon FSx deleted the backup and it’s no longer available.
• FAILED - Amazon FSx couldn’t finish the backup.

owner_id

Type: STRING
Provider name: OwnerId

progress_percent

Type: INT32
Provider name: ProgressPercent

resource_arn

Type: STRING
Provider name: ResourceARN
Description: The Amazon Resource Name (ARN) for the backup resource.

resource_type

Type: STRING
Provider name: ResourceType
Description: Specifies the resource type that’s backed up.

source_backup_id

Type: STRING
Provider name: SourceBackupId

source_backup_region

Type: STRING
Provider name: SourceBackupRegion
Description: The source Region of the backup. Specifies the Region from where this backup is copied.

tags

Type: UNORDERED_LIST_STRING

type

Type: STRING
Provider name: Type
Description: The type of the file-system backup.

volume

Type: STRUCT
Provider name: Volume

• creation_time
  Type: TIMESTAMP
  Provider name: CreationTime
  
• file_system_id
  Type: STRING
  Provider name: FileSystemId
  
• lifecycle
  Type: STRING
  Provider name: Lifecycle
  Description: The lifecycle status of the volume.
  • AVAILABLE - The volume is fully available for use.
  • CREATED - The volume has been created.
  • CREATING - Amazon FSx is creating the new volume.
  • DELETING - Amazon FSx is deleting an existing volume.
  • FAILED - Amazon FSx was unable to create the volume.
  • MISCONFIGURED - The volume is in a failed but recoverable state.
  • PENDING - Amazon FSx hasn’t started creating the volume.
• lifecycle_transition_reason
  Type: STRUCT
  Provider name: LifecycleTransitionReason
  Description: The reason why the volume lifecycle status changed.
  
  • message
    Type: STRING
    Provider name: Message
    
• name
  Type: STRING
  Provider name: Name
  Description: The name of the volume.
  
• ontap_configuration
  Type: STRUCT
  Provider name: OntapConfiguration
  
  • aggregate_configuration
    Type: STRUCT
    Provider name: AggregateConfiguration
    Description: This structure specifies configuration options for a volume’s storage aggregate or aggregates.
    
    • aggregates
      Type: UNORDERED_LIST_STRING
      Provider name: Aggregates
      Description: The list of aggregates that this volume resides on. Aggregates are storage pools which make up your primary storage tier. Each high-availability (HA) pair has one aggregate. The names of the aggregates map to the names of the aggregates in the ONTAP CLI and REST API. For FlexVols, there will always be a single entry. Amazon FSx responds with an HTTP status code 400 (Bad Request) for the following conditions:
      • The strings in the value of Aggregates are not are not formatted as aggrX, where X is a number between 1 and 12.
      • The value of Aggregates contains aggregates that are not present.
      • One or more of the aggregates supplied are too close to the volume limit to support adding more volumes.
    • total_constituents
      Type: INT32
      Provider name: TotalConstituents
      Description: The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.
      
  • copy_tags_to_backups
    Type: BOOLEAN
    Provider name: CopyTagsToBackups
    Description: A boolean flag indicating whether tags for the volume should be copied to backups. This value defaults to false. If it’s set to true, all tags for the volume 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 volume, regardless of this value.
    
  • flex_cache_endpoint_type
    Type: STRING
    Provider name: FlexCacheEndpointType
    Description: Specifies the FlexCache endpoint type of the volume. Valid values are the following:
    • NONE specifies that the volume doesn’t have a FlexCache configuration. NONE is the default.
    • ORIGIN specifies that the volume is the origin volume for a FlexCache volume.
    • CACHE specifies that the volume is a FlexCache volume.
  • junction_path
    Type: STRING
    Provider name: JunctionPath
    Description: Specifies the directory that network-attached storage (NAS) clients use to mount the volume, along with the storage virtual machine (SVM) Domain Name System (DNS) name or IP address. You can create a JunctionPath directly below a parent volume junction or on a directory within a volume. A JunctionPath for a volume named vol3 might be /vol1/vol2/vol3, or /vol1/dir2/vol3, or even /dir1/dir2/vol3.
    
  • ontap_volume_type
    Type: STRING
    Provider name: OntapVolumeType
    Description: Specifies the type of volume. Valid values are the following:
    • RW specifies a read/write volume. RW is the default.
    • DP specifies a data-protection volume. You can protect data by replicating it to data-protection mirror copies. If a disaster occurs, you can use these data-protection mirror copies to recover data.
    • LS specifies a load-sharing mirror volume. A load-sharing mirror reduces the network traffic to a FlexVol volume by providing additional read-only access to clients.
  • security_style
    Type: STRING
    Provider name: SecurityStyle
    Description: The security style for the volume, which can be UNIX, NTFS, or MIXED.
    
  • size_in_bytes
    Type: INT64
    Provider name: SizeInBytes
    Description: The configured size of the volume, in bytes.
    
  • size_in_megabytes
    Type: INT32
    Provider name: SizeInMegabytes
    Description: The configured size of the volume, in megabytes (MBs).
    
  • snaplock_configuration
    Type: STRUCT
    Provider name: SnaplockConfiguration
    Description: The SnapLock configuration object for an FSx for ONTAP SnapLock volume.
    
    • audit_log_volume
      Type: BOOLEAN
      Provider name: AuditLogVolume
      Description: Enables or disables the audit log volume for an FSx for ONTAP SnapLock volume. The default value is false. If you set AuditLogVolume to true, the SnapLock volume is created as an audit log volume. The minimum retention period for an audit log volume is six months. For more information, see SnapLock audit log volumes.
      
    • autocommit_period
      Type: STRUCT
      Provider name: AutocommitPeriod
      Description: The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.
      
      • type
        Type: STRING
        Provider name: Type
        Description: Defines the type of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. Setting this value to NONE disables autocommit. The default value is NONE.
        
      • value
        Type: INT32
        Provider name: Value
        Description: Defines the amount of time for the autocommit period of a file in an FSx for ONTAP SnapLock volume. The following ranges are valid:
        • Minutes: 5 - 65,535
        • Hours: 1 - 65,535
        • Days: 1 - 3,650
        • Months: 1 - 120
        • Years: 1 - 10
    • privileged_delete
      Type: STRING
      Provider name: PrivilegedDelete
      Description: Enables, disables, or permanently disables privileged delete on an FSx for ONTAP SnapLock Enterprise volume. Enabling privileged delete allows SnapLock administrators to delete write once, read many (WORM) files even if they have active retention periods. PERMANENTLY_DISABLED is a terminal state. If privileged delete is permanently disabled on a SnapLock volume, you can’t re-enable it. The default value is DISABLED. For more information, see Privileged delete.
      
    • retention_period
      Type: STRUCT
      Provider name: RetentionPeriod
      Description: Specifies the retention period of an FSx for ONTAP SnapLock volume.
      
      • default_retention
        Type: STRUCT
        Provider name: DefaultRetention
        Description: The retention period assigned to a write once, read many (WORM) file by default if an explicit retention period is not set for an FSx for ONTAP SnapLock volume. The default retention period must be greater than or equal to the minimum retention period and less than or equal to the maximum retention period.
        
        • type
          Type: STRING
          Provider name: Type
          Description: Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.
          
        • value
          Type: INT32
          Provider name: Value
          Description: Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can’t set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:
          • Seconds: 0 - 65,535
          • Minutes: 0 - 65,535
          • Hours: 0 - 24
          • Days: 0 - 365
          • Months: 0 - 12
          • Years: 0 - 100
      • maximum_retention
        Type: STRUCT
        Provider name: MaximumRetention
        Description: The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
        
        • type
          Type: STRING
          Provider name: Type
          Description: Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.
          
        • value
          Type: INT32
          Provider name: Value
          Description: Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can’t set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:
          • Seconds: 0 - 65,535
          • Minutes: 0 - 65,535
          • Hours: 0 - 24
          • Days: 0 - 365
          • Months: 0 - 12
          • Years: 0 - 100
      • minimum_retention
        Type: STRUCT
        Provider name: MinimumRetention
        Description: The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.
        
        • type
          Type: STRING
          Provider name: Type
          Description: Defines the type of time for the retention period of an FSx for ONTAP SnapLock volume. Set it to one of the valid types. If you set it to INFINITE, the files are retained forever. If you set it to UNSPECIFIED, the files are retained until you set an explicit retention period.
          
        • value
          Type: INT32
          Provider name: Value
          Description: Defines the amount of time for the retention period of an FSx for ONTAP SnapLock volume. You can’t set a value for INFINITE or UNSPECIFIED. For all other options, the following ranges are valid:
          • Seconds: 0 - 65,535
          • Minutes: 0 - 65,535
          • Hours: 0 - 24
          • Days: 0 - 365
          • Months: 0 - 12
          • Years: 0 - 100
    • snaplock_type
      Type: STRING
      Provider name: SnaplockType
      Description: Specifies the retention mode of an FSx for ONTAP SnapLock volume. After it is set, it can’t be changed. You can choose one of the following retention modes:
      • COMPLIANCE: Files transitioned to write once, read many (WORM) on a Compliance volume can’t be deleted until their retention periods expire. This retention mode is used to address government or industry-specific mandates or to protect against ransomware attacks. For more information, see SnapLock Compliance.
      • ENTERPRISE: Files transitioned to WORM on an Enterprise volume can be deleted by authorized users before their retention periods expire using privileged delete. This retention mode is used to advance an organization’s data integrity and internal compliance or to test retention settings before using SnapLock Compliance. For more information, see SnapLock Enterprise.
    • volume_append_mode_enabled
      Type: BOOLEAN
      Provider name: VolumeAppendModeEnabled
      Description: Enables or disables volume-append mode on an FSx for ONTAP SnapLock volume. Volume-append mode allows you to create WORM-appendable files and write data to them incrementally. The default value is false. For more information, see Volume-append mode.
      
  • snapshot_policy
    Type: STRING
    Provider name: SnapshotPolicy
    Description: Specifies the snapshot policy for the volume. There are three built-in snapshot policies:
    • default: This is the default policy. A maximum of six hourly snapshots taken five minutes past the hour. A maximum of two daily snapshots taken Monday through Saturday at 10 minutes after midnight. A maximum of two weekly snapshots taken every Sunday at 15 minutes after midnight.
    • default-1weekly: This policy is the same as the default policy except that it only retains one snapshot from the weekly schedule.
    • none: This policy does not take any snapshots. This policy can be assigned to volumes to prevent automatic snapshots from being taken.
    You can also provide the name of a custom policy that you created with the ONTAP CLI or REST API. For more information, see Snapshot policies in the Amazon FSx for NetApp ONTAP User Guide.
    
  • storage_efficiency_enabled
    Type: BOOLEAN
    Provider name: StorageEfficiencyEnabled
    Description: The volume’s storage efficiency setting.
    
  • storage_virtual_machine_id
    Type: STRING
    Provider name: StorageVirtualMachineId
    Description: The ID of the volume’s storage virtual machine.
    
  • storage_virtual_machine_root
    Type: BOOLEAN
    Provider name: StorageVirtualMachineRoot
    Description: A Boolean flag indicating whether this volume is the root volume for its storage virtual machine (SVM). Only one volume on an SVM can be the root volume. This value defaults to false. If this value is true, then this is the SVM root volume. This flag is useful when you’re deleting an SVM, because you must first delete all non-root volumes. This flag, when set to false, helps you identify which volumes to delete before you can delete the SVM.
    
  • tiering_policy
    Type: STRUCT
    Provider name: TieringPolicy
    Description: The volume’s TieringPolicy setting.
    
    • cooling_period
      Type: INT32
      Provider name: CoolingPeriod
      Description: Specifies the number of days that user data in a volume must remain inactive before it is considered “cold” and moved to the capacity pool. Used with the AUTO and SNAPSHOT_ONLY tiering policies. Enter a whole number between 2 and 183. Default values are 31 days for AUTO and 2 days for SNAPSHOT_ONLY.
      
    • name
      Type: STRING
      Provider name: Name
      Description: Specifies the tiering policy used to transition data. Default value is SNAPSHOT_ONLY.
      • SNAPSHOT_ONLY - moves cold snapshots to the capacity pool storage tier.
      • AUTO - moves cold user data and snapshots to the capacity pool storage tier based on your access patterns.
      • ALL - moves all user data blocks in both the active file system and Snapshot copies to the storage pool tier.
      • NONE - keeps a volume’s data in the primary storage tier, preventing it from being moved to the capacity pool tier.
  • uuid
    Type: STRING
    Provider name: UUID
    Description: The volume’s universally unique identifier (UUID).
    
  • volume_style
    Type: STRING
    Provider name: VolumeStyle
    Description: Use to specify the style of an ONTAP volume. For more information about FlexVols and FlexGroups, see Volume types in Amazon FSx for NetApp ONTAP User Guide.
    
• open_zfs_configuration
  Type: STRUCT
  Provider name: OpenZFSConfiguration
  Description: The configuration of an Amazon FSx for OpenZFS volume.
  
  • copy_strategy
    Type: STRING
    Provider name: CopyStrategy
    Description: Specifies the strategy used when copying data from the snapshot to the new volume.
    • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying data from the snapshot to a new volume and doesn’t consume disk throughput. However, the origin snapshot can’t be deleted if there is a volume using its copied data.
    • FULL_COPY - Copies all data from the snapshot to the new volume. Specify this option to create the volume from a snapshot on another FSx for OpenZFS file system.
    The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
    
  • copy_tags_to_snapshots
    Type: BOOLEAN
    Provider name: CopyTagsToSnapshots
    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.
    
  • data_compression_type
    Type: STRING
    Provider name: DataCompressionType
    Description: 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.
  • delete_cloned_volumes
    Type: BOOLEAN
    Provider name: DeleteClonedVolumes
    Description: A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.
    
  • delete_intermediate_data
    Type: BOOLEAN
    Provider name: DeleteIntermediateData
    Description: A Boolean value indicating whether snapshot data that differs between the current state and the specified snapshot should be overwritten when a volume is restored from a snapshot.
    
  • delete_intermediate_snaphots
    Type: BOOLEAN
    Provider name: DeleteIntermediateSnaphots
    Description: A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.
    
  • destination_snapshot
    Type: STRING
    Provider name: DestinationSnapshot
    Description: The ID of the snapshot that’s being copied or was most recently copied to the destination volume.
    
  • nfs_exports
    Type: UNORDERED_LIST_STRUCT
    Provider name: NfsExports
    Description: The configuration object for mounting a Network File System (NFS) file system.
    
    • client_configurations
      Type: UNORDERED_LIST_STRUCT
      Provider name: ClientConfigurations
      Description: A list of configuration objects that contain the client and options for mounting the OpenZFS file system.
      
      • clients
        Type: STRING
        Provider name: Clients
        Description: 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
        Type: UNORDERED_LIST_STRING
        Provider name: Options
        Description: 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.
  • origin_snapshot
    Type: STRUCT
    Provider name: OriginSnapshot
    Description: The configuration object that specifies the snapshot to use as the origin of the data for the volume.
    
    • copy_strategy
      Type: STRING
      Provider name: CopyStrategy
      Description: The strategy used when copying data from the snapshot to the new volume.
      • CLONE - The new volume references the data in the origin snapshot. Cloning a snapshot is faster than copying the data from a snapshot to a new volume and doesn’t consume disk throughput. However, the origin snapshot can’t be deleted if there is a volume using its copied data.
      • FULL_COPY - Copies all data from the snapshot to the new volume.
      The INCREMENTAL_COPY option is only for updating an existing volume by using a snapshot from another FSx for OpenZFS file system. For more information, see CopySnapshotAndUpdateVolume.
      
    • snapshot_arn
      Type: STRING
      Provider name: SnapshotARN
      
  • parent_volume_id
    Type: STRING
    Provider name: ParentVolumeId
    Description: The ID of the parent volume.
    
  • read_only
    Type: BOOLEAN
    Provider name: ReadOnly
    Description: A Boolean value indicating whether the volume is read-only.
    
  • record_size_kib
    Type: INT32
    Provider name: RecordSizeKiB
    Description: The record size of an OpenZFS 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. For guidance on when to set a custom record size, see the Amazon FSx for OpenZFS User Guide.
    
  • restore_to_snapshot
    Type: STRING
    Provider name: RestoreToSnapshot
    Description: Specifies the ID of the snapshot to which the volume was restored.
    
  • source_snapshot_arn
    Type: STRING
    Provider name: SourceSnapshotARN
    
  • storage_capacity_quota_gib
    Type: INT32
    Provider name: StorageCapacityQuotaGiB
    Description: The maximum amount of storage in gibibtyes (GiB) that the volume can use from its parent. You can specify a quota larger than the storage on the parent volume.
    
  • storage_capacity_reservation_gib
    Type: INT32
    Provider name: StorageCapacityReservationGiB
    Description: The amount of storage in gibibytes (GiB) to reserve from the parent volume. You can’t reserve more storage than the parent volume has reserved.
    
  • user_and_group_quotas
    Type: UNORDERED_LIST_STRUCT
    Provider name: UserAndGroupQuotas
    Description: An object specifying how much storage users or groups can use on the volume.
    
    • id
      Type: INT32
      Provider name: Id
      Description: The ID of the user or group that the quota applies to.
      
    • storage_capacity_quota_gib
      Type: INT32
      Provider name: StorageCapacityQuotaGiB
      Description: The user or group’s storage quota, in gibibytes (GiB).
      
    • type
      Type: STRING
      Provider name: Type
      Description: Specifies whether the quota applies to a user or group.
      
  • volume_path
    Type: STRING
    Provider name: VolumePath
    Description: The path to the volume from the root volume. For example, fsx/parentVolume/volume1.
    
• resource_arn
  Type: STRING
  Provider name: ResourceARN
  
• volume_id
  Type: STRING
  Provider name: VolumeId
  Description: The system-generated, unique ID of the volume.
  
• volume_type
  Type: STRING
  Provider name: VolumeType
  Description: The type of the volume.