FSx / Client / create_snapshot

create_snapshot#

FSx.Client.create_snapshot(**kwargs)#

Creates a snapshot of an existing Amazon FSx for OpenZFS volume. With snapshots, you can easily undo file changes and compare file versions by restoring the volume to a previous version.

If a snapshot with the specified client request token exists, and the parameters match, this operation returns the description of the existing snapshot. If a snapshot with the specified client request token exists, and the parameters don’t match, this operation returns IncompatibleParameterError. If a snapshot with the specified client request token doesn’t exist, CreateSnapshot does the following:

Creates a new OpenZFS snapshot with an assigned ID, and an initial lifecycle state of CREATING.

Returns the description of the snapshot.

By using the idempotent operation, you can retry a CreateSnapshot operation without the risk of creating an extra snapshot. This approach can be useful when an initial call fails in a way that makes it unclear whether a snapshot was created. If you use the same client request token and the initial call created a snapshot, the operation returns a successful result because all the parameters are the same.

The CreateSnapshot operation returns while the snapshot’s lifecycle state is still CREATING. You can check the snapshot creation status by calling the DescribeSnapshots operation, which returns the snapshot state along with other information.

See also: AWS API Documentation

Request Syntax
response = client.create_snapshot(
    ClientRequestToken='string',
    Name='string',
    VolumeId='string',
    Tags=[
        {
            'Key': 'string',
            'Value': 'string'
        },
    ]
)
type ClientRequestToken:

string

param ClientRequestToken:

(Optional) An idempotency token for resource creation, in a string of up to 63 ASCII characters. This token is automatically filled on your behalf when you use the Command Line Interface (CLI) or an Amazon Web Services SDK.

This field is autopopulated if not provided.

type Name:

string

param Name:

[REQUIRED]

The name of the snapshot.

type VolumeId:

string

param VolumeId:

[REQUIRED]

The ID of the volume that you are taking a snapshot of.

type Tags:

list

param Tags:

A list of Tag values, with a maximum of 50 elements.

(dict) –

Specifies a key-value pair for a resource tag.

Key (string) – [REQUIRED]

A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value (string) – [REQUIRED]

A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

rtype:

dict

returns:
Response Syntax
{
    'Snapshot': {
        'ResourceARN': 'string',
        'SnapshotId': 'string',
        'Name': 'string',
        'VolumeId': 'string',
        'CreationTime': datetime(2015, 1, 1),
        'Lifecycle': 'PENDING'|'CREATING'|'DELETING'|'AVAILABLE',
        'LifecycleTransitionReason': {
            'Message': 'string'
        },
        'Tags': [
            {
                'Key': 'string',
                'Value': 'string'
            },
        ],
        'AdministrativeActions': [
            {
                'AdministrativeActionType': 'FILE_SYSTEM_UPDATE'|'STORAGE_OPTIMIZATION'|'FILE_SYSTEM_ALIAS_ASSOCIATION'|'FILE_SYSTEM_ALIAS_DISASSOCIATION'|'VOLUME_UPDATE'|'SNAPSHOT_UPDATE'|'RELEASE_NFS_V3_LOCKS'|'VOLUME_RESTORE'|'THROUGHPUT_OPTIMIZATION'|'IOPS_OPTIMIZATION'|'STORAGE_TYPE_OPTIMIZATION'|'MISCONFIGURED_STATE_RECOVERY'|'VOLUME_UPDATE_WITH_SNAPSHOT'|'VOLUME_INITIALIZE_WITH_SNAPSHOT'|'DOWNLOAD_DATA_FROM_BACKUP',
                'ProgressPercent': 123,
                'RequestTime': datetime(2015, 1, 1),
                'Status': 'FAILED'|'IN_PROGRESS'|'PENDING'|'COMPLETED'|'UPDATED_OPTIMIZING'|'OPTIMIZING',
                'TargetFileSystemValues': {
                    'OwnerId': 'string',
                    'CreationTime': datetime(2015, 1, 1),
                    'FileSystemId': 'string',
                    'FileSystemType': 'WINDOWS'|'LUSTRE'|'ONTAP'|'OPENZFS',
                    'Lifecycle': 'AVAILABLE'|'CREATING'|'FAILED'|'DELETING'|'MISCONFIGURED'|'UPDATING'|'MISCONFIGURED_UNAVAILABLE',
                    'FailureDetails': {
                        'Message': 'string'
                    },
                    'StorageCapacity': 123,
                    'StorageType': 'SSD'|'HDD'|'INTELLIGENT_TIERING',
                    'VpcId': 'string',
                    'SubnetIds': [
                        'string',
                    ],
                    'NetworkInterfaceIds': [
                        'string',
                    ],
                    'DNSName': 'string',
                    'KmsKeyId': 'string',
                    'ResourceARN': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'WindowsConfiguration': {
                        'ActiveDirectoryId': 'string',
                        'SelfManagedActiveDirectoryConfiguration': {
                            'DomainName': 'string',
                            'OrganizationalUnitDistinguishedName': 'string',
                            'FileSystemAdministratorsGroup': 'string',
                            'UserName': 'string',
                            'DnsIps': [
                                'string',
                            ]
                        },
                        'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2',
                        'RemoteAdministrationEndpoint': 'string',
                        'PreferredSubnetId': 'string',
                        'PreferredFileServerIp': 'string',
                        'ThroughputCapacity': 123,
                        'MaintenanceOperationsInProgress': [
                            'PATCHING'|'BACKING_UP',
                        ],
                        'WeeklyMaintenanceStartTime': 'string',
                        'DailyAutomaticBackupStartTime': 'string',
                        'AutomaticBackupRetentionDays': 123,
                        'CopyTagsToBackups': True|False,
                        'Aliases': [
                            {
                                'Name': 'string',
                                'Lifecycle': 'AVAILABLE'|'CREATING'|'DELETING'|'CREATE_FAILED'|'DELETE_FAILED'
                            },
                        ],
                        'AuditLogConfiguration': {
                            'FileAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
                            'FileShareAccessAuditLogLevel': 'DISABLED'|'SUCCESS_ONLY'|'FAILURE_ONLY'|'SUCCESS_AND_FAILURE',
                            'AuditLogDestination': 'string'
                        },
                        'DiskIopsConfiguration': {
                            'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
                            'Iops': 123
                        }
                    },
                    'LustreConfiguration': {
                        'WeeklyMaintenanceStartTime': 'string',
                        'DataRepositoryConfiguration': {
                            'Lifecycle': 'CREATING'|'AVAILABLE'|'MISCONFIGURED'|'UPDATING'|'DELETING'|'FAILED',
                            'ImportPath': 'string',
                            'ExportPath': 'string',
                            'ImportedFileChunkSize': 123,
                            'AutoImportPolicy': 'NONE'|'NEW'|'NEW_CHANGED'|'NEW_CHANGED_DELETED',
                            'FailureDetails': {
                                'Message': 'string'
                            }
                        },
                        'DeploymentType': 'SCRATCH_1'|'SCRATCH_2'|'PERSISTENT_1'|'PERSISTENT_2',
                        'PerUnitStorageThroughput': 123,
                        'MountName': 'string',
                        'DailyAutomaticBackupStartTime': 'string',
                        'AutomaticBackupRetentionDays': 123,
                        'CopyTagsToBackups': True|False,
                        'DriveCacheType': 'NONE'|'READ',
                        'DataCompressionType': 'NONE'|'LZ4',
                        'LogConfiguration': {
                            'Level': 'DISABLED'|'WARN_ONLY'|'ERROR_ONLY'|'WARN_ERROR',
                            'Destination': 'string'
                        },
                        'RootSquashConfiguration': {
                            'RootSquash': 'string',
                            'NoSquashNids': [
                                'string',
                            ]
                        },
                        'MetadataConfiguration': {
                            'Iops': 123,
                            'Mode': 'AUTOMATIC'|'USER_PROVISIONED'
                        },
                        'EfaEnabled': True|False
                    },
                    'AdministrativeActions': {'... recursive ...'},
                    'OntapConfiguration': {
                        'AutomaticBackupRetentionDays': 123,
                        'DailyAutomaticBackupStartTime': 'string',
                        'DeploymentType': 'MULTI_AZ_1'|'SINGLE_AZ_1'|'SINGLE_AZ_2'|'MULTI_AZ_2',
                        'EndpointIpAddressRange': 'string',
                        'Endpoints': {
                            'Intercluster': {
                                'DNSName': 'string',
                                'IpAddresses': [
                                    'string',
                                ]
                            },
                            'Management': {
                                'DNSName': 'string',
                                'IpAddresses': [
                                    'string',
                                ]
                            }
                        },
                        'DiskIopsConfiguration': {
                            'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
                            'Iops': 123
                        },
                        'PreferredSubnetId': 'string',
                        'RouteTableIds': [
                            'string',
                        ],
                        'ThroughputCapacity': 123,
                        'WeeklyMaintenanceStartTime': 'string',
                        'FsxAdminPassword': 'string',
                        'HAPairs': 123,
                        'ThroughputCapacityPerHAPair': 123
                    },
                    'FileSystemTypeVersion': 'string',
                    'OpenZFSConfiguration': {
                        'AutomaticBackupRetentionDays': 123,
                        'CopyTagsToBackups': True|False,
                        'CopyTagsToVolumes': True|False,
                        'DailyAutomaticBackupStartTime': 'string',
                        'DeploymentType': 'SINGLE_AZ_1'|'SINGLE_AZ_2'|'SINGLE_AZ_HA_1'|'SINGLE_AZ_HA_2'|'MULTI_AZ_1',
                        'ThroughputCapacity': 123,
                        'WeeklyMaintenanceStartTime': 'string',
                        'DiskIopsConfiguration': {
                            'Mode': 'AUTOMATIC'|'USER_PROVISIONED',
                            'Iops': 123
                        },
                        'RootVolumeId': 'string',
                        'PreferredSubnetId': 'string',
                        'EndpointIpAddressRange': 'string',
                        'RouteTableIds': [
                            'string',
                        ],
                        'EndpointIpAddress': 'string',
                        'ReadCacheConfiguration': {
                            'SizingMode': 'NO_CACHE'|'USER_PROVISIONED'|'PROPORTIONAL_TO_THROUGHPUT_CAPACITY',
                            'SizeGiB': 123
                        }
                    }
                },
                'FailureDetails': {
                    'Message': 'string'
                },
                'TargetVolumeValues': {
                    'CreationTime': datetime(2015, 1, 1),
                    'FileSystemId': 'string',
                    'Lifecycle': 'CREATING'|'CREATED'|'DELETING'|'FAILED'|'MISCONFIGURED'|'PENDING'|'AVAILABLE',
                    'Name': 'string',
                    'OntapConfiguration': {
                        'FlexCacheEndpointType': 'NONE'|'ORIGIN'|'CACHE',
                        'JunctionPath': 'string',
                        'SecurityStyle': 'UNIX'|'NTFS'|'MIXED',
                        'SizeInMegabytes': 123,
                        'StorageEfficiencyEnabled': True|False,
                        'StorageVirtualMachineId': 'string',
                        'StorageVirtualMachineRoot': True|False,
                        'TieringPolicy': {
                            'CoolingPeriod': 123,
                            'Name': 'SNAPSHOT_ONLY'|'AUTO'|'ALL'|'NONE'
                        },
                        'UUID': 'string',
                        'OntapVolumeType': 'RW'|'DP'|'LS',
                        'SnapshotPolicy': 'string',
                        'CopyTagsToBackups': True|False,
                        'SnaplockConfiguration': {
                            'AuditLogVolume': True|False,
                            'AutocommitPeriod': {
                                'Type': 'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'NONE',
                                'Value': 123
                            },
                            'PrivilegedDelete': 'DISABLED'|'ENABLED'|'PERMANENTLY_DISABLED',
                            'RetentionPeriod': {
                                'DefaultRetention': {
                                    'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED',
                                    'Value': 123
                                },
                                'MinimumRetention': {
                                    'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED',
                                    'Value': 123
                                },
                                'MaximumRetention': {
                                    'Type': 'SECONDS'|'MINUTES'|'HOURS'|'DAYS'|'MONTHS'|'YEARS'|'INFINITE'|'UNSPECIFIED',
                                    'Value': 123
                                }
                            },
                            'SnaplockType': 'COMPLIANCE'|'ENTERPRISE',
                            'VolumeAppendModeEnabled': True|False
                        },
                        'VolumeStyle': 'FLEXVOL'|'FLEXGROUP',
                        'AggregateConfiguration': {
                            'Aggregates': [
                                'string',
                            ],
                            'TotalConstituents': 123
                        },
                        'SizeInBytes': 123
                    },
                    'ResourceARN': 'string',
                    'Tags': [
                        {
                            'Key': 'string',
                            'Value': 'string'
                        },
                    ],
                    'VolumeId': 'string',
                    'VolumeType': 'ONTAP'|'OPENZFS',
                    'LifecycleTransitionReason': {
                        'Message': 'string'
                    },
                    'AdministrativeActions': {'... recursive ...'},
                    'OpenZFSConfiguration': {
                        'ParentVolumeId': 'string',
                        'VolumePath': 'string',
                        'StorageCapacityReservationGiB': 123,
                        'StorageCapacityQuotaGiB': 123,
                        'RecordSizeKiB': 123,
                        'DataCompressionType': 'NONE'|'ZSTD'|'LZ4',
                        'CopyTagsToSnapshots': True|False,
                        'OriginSnapshot': {
                            'SnapshotARN': 'string',
                            'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY'
                        },
                        'ReadOnly': True|False,
                        'NfsExports': [
                            {
                                'ClientConfigurations': [
                                    {
                                        'Clients': 'string',
                                        'Options': [
                                            'string',
                                        ]
                                    },
                                ]
                            },
                        ],
                        'UserAndGroupQuotas': [
                            {
                                'Type': 'USER'|'GROUP',
                                'Id': 123,
                                'StorageCapacityQuotaGiB': 123
                            },
                        ],
                        'RestoreToSnapshot': 'string',
                        'DeleteIntermediateSnaphots': True|False,
                        'DeleteClonedVolumes': True|False,
                        'DeleteIntermediateData': True|False,
                        'SourceSnapshotARN': 'string',
                        'DestinationSnapshot': 'string',
                        'CopyStrategy': 'CLONE'|'FULL_COPY'|'INCREMENTAL_COPY'
                    }
                },
                'TargetSnapshotValues': {'... recursive ...'},
                'TotalTransferBytes': 123,
                'RemainingTransferBytes': 123
            },
        ]
    }
}
Response Structure

(dict) –

Snapshot (dict) –

A description of the snapshot.

ResourceARN (string) –

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

SnapshotId (string) –

The ID of the snapshot.

Name (string) –

The name of the snapshot.

VolumeId (string) –

The ID of the volume that the snapshot is of.

CreationTime (datetime) –

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

Lifecycle (string) –

The lifecycle status of the snapshot.

PENDING - Amazon FSx hasn’t started creating the snapshot.

CREATING - Amazon FSx is creating the snapshot.

DELETING - Amazon FSx is deleting the snapshot.

AVAILABLE - The snapshot is fully available.

LifecycleTransitionReason (dict) –

Describes why a resource lifecycle state changed.

Message (string) –

A detailed error message.

Tags (list) –

A list of Tag values, with a maximum of 50 elements.

(dict) –

Specifies a key-value pair for a resource tag.

Key (string) –

A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value (string) –

A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

AdministrativeActions (list) –

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system.

(dict) –

Describes a specific Amazon FSx administrative action for the current Windows, Lustre, OpenZFS, or ONTAP file system or volume.

AdministrativeActionType (string) –

Describes the type of administrative action, as follows:

FILE_SYSTEM_UPDATE - A file system update administrative action initiated from the Amazon FSx console, API ( UpdateFileSystem), or CLI ( update-file-system).

THROUGHPUT_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system’s throughput capacity has been completed successfully, a THROUGHPUT_OPTIMIZATION task starts. You can track the storage-optimization progress using the ProgressPercent property. When THROUGHPUT_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing throughput capacity in the Amazon FSx for Windows File Server User Guide.

STORAGE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system’s storage capacity has completed successfully, a STORAGE_OPTIMIZATION task starts.

For Windows and ONTAP, storage optimization is the process of migrating the file system data to newer larger disks.

For Lustre, storage optimization consists of rebalancing the data across the existing and newly added file servers.

You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing storage capacity in the Amazon FSx for Windows File Server User Guide, Managing storage capacity in the Amazon FSx for Lustre User Guide, and Managing storage capacity and provisioned IOPS in the Amazon FSx for NetApp ONTAP User Guide.

FILE_SYSTEM_ALIAS_ASSOCIATION - A file system update to associate a new Domain Name System (DNS) alias with the file system. For more information, see AssociateFileSystemAliases.

FILE_SYSTEM_ALIAS_DISASSOCIATION - A file system update to disassociate a DNS alias from the file system. For more information, see DisassociateFileSystemAliases.

IOPS_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system’s throughput capacity has been completed successfully, a IOPS_OPTIMIZATION task starts. You can track the storage-optimization progress using the ProgressPercent property. When IOPS_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED. For more information, see Managing provisioned SSD IOPS in the Amazon FSx for Windows File Server User Guide.

STORAGE_TYPE_OPTIMIZATION - After the FILE_SYSTEM_UPDATE task to increase a file system’s throughput capacity has been completed successfully, a STORAGE_TYPE_OPTIMIZATION task starts. You can track the storage-optimization progress using the ProgressPercent property. When STORAGE_TYPE_OPTIMIZATION has been completed successfully, the parent FILE_SYSTEM_UPDATE action status changes to COMPLETED.

VOLUME_UPDATE - A volume update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( UpdateVolume), or CLI ( update-volume).

VOLUME_RESTORE - An Amazon FSx for OpenZFS volume is returned to the state saved by the specified snapshot, initiated from an API ( RestoreVolumeFromSnapshot) or CLI ( restore-volume-from-snapshot).

SNAPSHOT_UPDATE - A snapshot update to an Amazon FSx for OpenZFS volume initiated from the Amazon FSx console, API ( UpdateSnapshot), or CLI ( update-snapshot).

RELEASE_NFS_V3_LOCKS - Tracks the release of Network File System (NFS) V3 locks on an Amazon FSx for OpenZFS file system.

DOWNLOAD_DATA_FROM_BACKUP - An FSx for ONTAP backup is being restored to a new volume on a second-generation file system. Once the all the file metadata is loaded onto the volume, you can mount the volume with read-only access. during this process.

VOLUME_INITIALIZE_WITH_SNAPSHOT - A volume is being created from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( CreateVolume), or CLI ( create-volume) when using the using the FULL_COPY strategy.

VOLUME_UPDATE_WITH_SNAPSHOT - A volume is being updated from a snapshot on a different FSx for OpenZFS file system. You can initiate this from the Amazon FSx console, API ( CopySnapshotAndUpdateVolume), or CLI ( copy-snapshot-and-update-volume).

ProgressPercent (integer) –

The percentage-complete status of a STORAGE_OPTIMIZATION or DOWNLOAD_DATA_FROM_BACKUP administrative action. Does not apply to any other administrative action type.

RequestTime (datetime) –

The time that the administrative action request was received.

Status (string) –

The status of the administrative action, as follows:

FAILED - Amazon FSx failed to process the administrative action successfully.

IN_PROGRESS - Amazon FSx is processing the administrative action.

PENDING - Amazon FSx is waiting to process the administrative action.

COMPLETED - Amazon FSx has finished processing the administrative task. For a backup restore to a second-generation FSx for ONTAP file system, indicates that all data has been downloaded to the volume, and clients now have read-write access to volume.

UPDATED_OPTIMIZING - For a storage-capacity increase update, Amazon FSx has updated the file system with the new storage capacity, and is now performing the storage-optimization process.

PENDING - For a backup restore to a second-generation FSx for ONTAP file system, indicates that the file metadata is being downloaded onto the volume. The volume’s Lifecycle state is CREATING.

IN_PROGRESS - For a backup restore to a second-generation FSx for ONTAP file system, indicates that all metadata has been downloaded to the new volume and client can access data with read-only access while Amazon FSx downloads the file data to the volume. Track the progress of this process with the ProgressPercent element.

TargetFileSystemValues (dict) –

The target value for the administration action, provided in the UpdateFileSystem operation. Returned for FILE_SYSTEM_UPDATE administrative actions.

OwnerId (string) –

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.

CreationTime (datetime) –

The time that the file system was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId (string) –

The system-generated, unique 17-digit ID of the file system.

FileSystemType (string) –

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

Lifecycle (string) –

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.

FailureDetails (dict) –

A structure providing details of any failures that occurred.

Message (string) –

A message describing any failures that occurred.

StorageCapacity (integer) –

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.

StorageType (string) –

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.

VpcId (string) –

The ID of the primary virtual private cloud (VPC) for the file system.

SubnetIds (list) –

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.

(string) –

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

NetworkInterfaceIds (list) –

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.

(string) –

An elastic network interface ID. An elastic network interface is a logical networking component in a virtual private cloud (VPC) that represents a virtual network card. For more information, see Elastic Network Interfaces in the Amazon EC2 User Guide for Linux Instances.

DNSName (string) –

The Domain Name System (DNS) name for the file system.

KmsKeyId (string) –

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

ResourceARN (string) –

The Amazon Resource Name (ARN) of the file system resource.

Tags (list) –

The tags to associate with the file system. For more information, see Tagging your Amazon FSx resources in the Amazon FSx for Lustre User Guide.

(dict) –

Specifies a key-value pair for a resource tag.

Key (string) –

A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value (string) –

A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

WindowsConfiguration (dict) –

The configuration for this Amazon FSx for Windows File Server file system.

ActiveDirectoryId (string) –

The ID for an existing Amazon Web Services Managed Microsoft Active Directory instance that the file system is joined to.

SelfManagedActiveDirectoryConfiguration (dict) –

The configuration of the self-managed Microsoft Active Directory (AD) directory to which the Windows File Server or ONTAP storage virtual machine (SVM) instance is joined.

DomainName (string) –

The fully qualified domain name of the self-managed AD directory.

OrganizationalUnitDistinguishedName (string) –

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.

FileSystemAdministratorsGroup (string) –

The name of the domain group whose members have administrative privileges for the FSx file system.

UserName (string) –

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

DnsIps (list) –

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

(string) –

DeploymentType (string) –

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.

RemoteAdministrationEndpoint (string) –

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.

PreferredSubnetId (string) –

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.

PreferredFileServerIp (string) –

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.

ThroughputCapacity (integer) –

The throughput of the Amazon FSx file system, measured in megabytes per second.

MaintenanceOperationsInProgress (list) –

The list of maintenance operations in progress for this file system.

(string) –

An enumeration specifying the currently ongoing maintenance operation.

WeeklyMaintenanceStartTime (string) –

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.

DailyAutomaticBackupStartTime (string) –

The preferred time to take daily automatic backups, in the UTC time zone.

AutomaticBackupRetentionDays (integer) –

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.

CopyTagsToBackups (boolean) –

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.

Aliases (list) –

An array of one or more DNS aliases that are currently associated with the Amazon FSx file system. Aliases allow you to use existing DNS names to access the data in your Amazon FSx file system. You can associate up to 50 aliases with a file system at any time. You can associate additional DNS aliases after you create the file system using the AssociateFileSystemAliases operation. You can remove DNS aliases from the file system after it is created using the DisassociateFileSystemAliases operation. You only need to specify the alias name in the request payload. For more information, see DNS aliases.

(dict) –

A DNS alias that is associated with the file system. You can use a DNS alias to access a file system using user-defined DNS names, in addition to the default DNS name that Amazon FSx assigns to the file system. For more information, see DNS aliases in the FSx for Windows File Server User Guide.

Name (string) –

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.

Lifecycle (string) –

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.

AuditLogConfiguration (dict) –

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.

FileAccessAuditLogLevel (string) –

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.

FileShareAccessAuditLogLevel (string) –

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.

AuditLogDestination (string) –

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.

DiskIopsConfiguration (dict) –

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.

Mode (string) –

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.

Iops (integer) –

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.

LustreConfiguration (dict) –

The configuration for the Amazon FSx for Lustre file system.

WeeklyMaintenanceStartTime (string) –

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.

DataRepositoryConfiguration (dict) –

The data repository configuration object for Lustre file systems returned in the response of the CreateFileSystem operation.

This data type is not supported on file systems with a data repository association. For file systems with a data repository association, see .

Lifecycle (string) –

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.

ImportPath (string) –

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.

ExportPath (string) –

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.

ImportedFileChunkSize (integer) –

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.

AutoImportPolicy (string) –

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.

FailureDetails (dict) –

Provides detailed information about the data repository if its Lifecycle is set to MISCONFIGURED or FAILED.

Message (string) –

A detailed error message.

DeploymentType (string) –

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.

PerUnitStorageThroughput (integer) –

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.

MountName (string) –

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.

DailyAutomaticBackupStartTime (string) –

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

AutomaticBackupRetentionDays (integer) –

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

CopyTagsToBackups (boolean) –

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)

DriveCacheType (string) –

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.

DataCompressionType (string) –

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.

LogConfiguration (dict) –

The Lustre logging configuration. Lustre logging writes the enabled log events for your file system to Amazon CloudWatch Logs.

Level (string) –

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.

Destination (string) –

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.

RootSquashConfiguration (dict) –

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.

RootSquash (string) –

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.

NoSquashNids (list) –

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

(string) –

MetadataConfiguration (dict) –

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

Iops (integer) –

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 (string) –

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.

EfaEnabled (boolean) –

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

AdministrativeActions (list) –

A list of administrative actions for the file system that are in process or waiting to be processed. Administrative actions describe changes to the Amazon FSx system that you have initiated using the UpdateFileSystem operation.

OntapConfiguration (dict) –

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

AutomaticBackupRetentionDays (integer) –

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

DailyAutomaticBackupStartTime (string) –

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

DeploymentType (string) –

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.

EndpointIpAddressRange (string) –

(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 (dict) –

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 (dict) –

An endpoint for managing your file system by setting up NetApp SnapMirror with other ONTAP systems.

DNSName (string) –

The file system’s DNS name. You can mount your file system using its DNS name.

IpAddresses (list) –

IP addresses of the file system endpoint.

(string) –

Management (dict) –

An endpoint for managing your file system using the NetApp ONTAP CLI and NetApp ONTAP API.

DNSName (string) –

The file system’s DNS name. You can mount your file system using its DNS name.

IpAddresses (list) –

IP addresses of the file system endpoint.

(string) –

DiskIopsConfiguration (dict) –

The SSD IOPS configuration for the ONTAP file system, specifying the number of provisioned IOPS and the provision mode.

Mode (string) –

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.

Iops (integer) –

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.

PreferredSubnetId (string) –

The ID for a subnet. A subnet is a range of IP addresses in your virtual private cloud (VPC). For more information, see VPC and subnets in the Amazon VPC User Guide.

RouteTableIds (list) –

(Multi-AZ only) The VPC route tables in which your file system’s endpoints are created.

(string) –

ThroughputCapacity (integer) –

The sustained throughput of an Amazon FSx file system in Megabytes per second (MBps).

WeeklyMaintenanceStartTime (string) –

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

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

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

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

FsxAdminPassword (string) –

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.

HAPairs (integer) –

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.

ThroughputCapacityPerHAPair (integer) –

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.

FileSystemTypeVersion (string) –

The Lustre version of the Amazon FSx for Lustre file system, which can be 2.10, 2.12, or 2.15.

OpenZFSConfiguration (dict) –

The configuration for this Amazon FSx for OpenZFS file system.

AutomaticBackupRetentionDays (integer) –

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

CopyTagsToBackups (boolean) –

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.

CopyTagsToVolumes (boolean) –

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.

DailyAutomaticBackupStartTime (string) –

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

DeploymentType (string) –

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.

ThroughputCapacity (integer) –

The throughput of an Amazon FSx file system, measured in megabytes per second (MBps).

WeeklyMaintenanceStartTime (string) –

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

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

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

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

DiskIopsConfiguration (dict) –

The SSD IOPS (input/output operations per second) configuration for an Amazon FSx for NetApp ONTAP, Amazon FSx for Windows File Server, or FSx for OpenZFS file system. By default, Amazon FSx automatically provisions 3 IOPS per GB of storage capacity. You can provision additional IOPS per GB of storage. The configuration consists of the total number of provisioned SSD IOPS and how it is was provisioned, or the mode (by the customer or by Amazon FSx).

Mode (string) –

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.

Iops (integer) –

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.

RootVolumeId (string) –

The ID of the root volume of the OpenZFS file system.

PreferredSubnetId (string) –

Required when DeploymentType is set to MULTI_AZ_1. This specifies the subnet in which you want the preferred file server to be located.

EndpointIpAddressRange (string) –

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

RouteTableIds (list) –

(Multi-AZ only) The VPC route tables in which your file system’s endpoints are created.

(string) –

EndpointIpAddress (string) –

The IP address of the endpoint that is used to access data or to manage the file system.

ReadCacheConfiguration (dict) –

Required when StorageType is set to INTELLIGENT_TIERING. Specifies the optional provisioned SSD read cache.

SizingMode (string) –

Specifies how the provisioned SSD read cache is sized, as follows:

Set to NO_CACHE if you do not want to use an SSD read cache with your Intelligent-Tiering file system.

Set to USER_PROVISIONED to specify the exact size of your SSD read cache.

Set to PROPORTIONAL_TO_THROUGHPUT_CAPACITY to have your SSD read cache automatically sized based on your throughput capacity.

SizeGiB (integer) –

Required if SizingMode is set to USER_PROVISIONED. Specifies the size of the file system’s SSD read cache, in gibibytes (GiB).

FailureDetails (dict) –

Provides information about a failed administrative action.

Message (string) –

Error message providing details about the failed administrative action.

TargetVolumeValues (dict) –

Describes an Amazon FSx volume.

CreationTime (datetime) –

The time that the resource was created, in seconds (since 1970-01-01T00:00:00Z), also known as Unix time.

FileSystemId (string) –

The globally unique ID of the file system, assigned by Amazon FSx.

Lifecycle (string) –

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.

Name (string) –

The name of the volume.

OntapConfiguration (dict) –

The configuration of an Amazon FSx for NetApp ONTAP volume.

FlexCacheEndpointType (string) –

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.

JunctionPath (string) –

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.

SecurityStyle (string) –

The security style for the volume, which can be UNIX, NTFS, or MIXED.

SizeInMegabytes (integer) –

The configured size of the volume, in megabytes (MBs).

StorageEfficiencyEnabled (boolean) –

The volume’s storage efficiency setting.

StorageVirtualMachineId (string) –

The ID of the volume’s storage virtual machine.

StorageVirtualMachineRoot (boolean) –

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.

TieringPolicy (dict) –

The volume’s TieringPolicy setting.

CoolingPeriod (integer) –

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 (string) –

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 (string) –

The volume’s universally unique identifier (UUID).

OntapVolumeType (string) –

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.

SnapshotPolicy (string) –

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.

CopyTagsToBackups (boolean) –

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.

SnaplockConfiguration (dict) –

The SnapLock configuration object for an FSx for ONTAP SnapLock volume.

AuditLogVolume (boolean) –

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.

AutocommitPeriod (dict) –

The configuration object for setting the autocommit period of files in an FSx for ONTAP SnapLock volume.

Type (string) –

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 (integer) –

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

PrivilegedDelete (string) –

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.

RetentionPeriod (dict) –

Specifies the retention period of an FSx for ONTAP SnapLock volume.

DefaultRetention (dict) –

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 (string) –

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 (integer) –

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

MinimumRetention (dict) –

The shortest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

Type (string) –

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 (integer) –

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

MaximumRetention (dict) –

The longest retention period that can be assigned to a WORM file on an FSx for ONTAP SnapLock volume.

Type (string) –

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 (integer) –

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

SnaplockType (string) –

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.

VolumeAppendModeEnabled (boolean) –

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.

VolumeStyle (string) –

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.

AggregateConfiguration (dict) –

This structure specifies configuration options for a volume’s storage aggregate or aggregates.

Aggregates (list) –

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.

(string) –

TotalConstituents (integer) –

The total number of constituents this FlexGroup volume has. Not applicable for FlexVols.

SizeInBytes (integer) –

The configured size of the volume, in bytes.

ResourceARN (string) –

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

Tags (list) –

A list of Tag values, with a maximum of 50 elements.

(dict) –

Specifies a key-value pair for a resource tag.

Key (string) –

A value that specifies the TagKey, the name of the tag. Tag keys must be unique for the resource to which they are attached.

Value (string) –

A value that specifies the TagValue, the value assigned to the corresponding tag key. Tag values can be null and don’t have to be unique in a tag set. For example, you can have a key-value pair in a tag set of finances : April and also of payroll : April.

VolumeId (string) –

The system-generated, unique ID of the volume.

VolumeType (string) –

The type of the volume.

LifecycleTransitionReason (dict) –

The reason why the volume lifecycle status changed.

Message (string) –

A detailed error message.

AdministrativeActions (list) –

A list of administrative actions for the volume that are in process or waiting to be processed. Administrative actions describe changes to the volume that you have initiated using the UpdateVolume action.

OpenZFSConfiguration (dict) –

The configuration of an Amazon FSx for OpenZFS volume.

ParentVolumeId (string) –

The ID of the parent volume.

VolumePath (string) –

The path to the volume from the root volume. For example, fsx/parentVolume/volume1.

StorageCapacityReservationGiB (integer) –

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.

StorageCapacityQuotaGiB (integer) –

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.

RecordSizeKiB (integer) –

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.

DataCompressionType (string) –

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.

CopyTagsToSnapshots (boolean) –

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.

OriginSnapshot (dict) –

The configuration object that specifies the snapshot to use as the origin of the data for the volume.

SnapshotARN (string) –

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

CopyStrategy (string) –

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.

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

ReadOnly (boolean) –

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

NfsExports (list) –

The configuration object for mounting a Network File System (NFS) file system.

(dict) –

The Network File System (NFS) configurations for mounting an Amazon FSx for OpenZFS file system.

ClientConfigurations (list) –

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

(dict) –

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

Clients (string) –

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 (list) –

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.

(string) –

UserAndGroupQuotas (list) –

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

(dict) –

Used to configure quotas that define how much storage a user or group can use on an FSx for OpenZFS volume. For more information, see Volume properties in the FSx for OpenZFS User Guide.

Type (string) –

Specifies whether the quota applies to a user or group.

Id (integer) –

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

StorageCapacityQuotaGiB (integer) –

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

RestoreToSnapshot (string) –

Specifies the ID of the snapshot to which the volume was restored.

DeleteIntermediateSnaphots (boolean) –

A Boolean value indicating whether snapshots between the current state and the specified snapshot should be deleted when a volume is restored from snapshot.

DeleteClonedVolumes (boolean) –

A Boolean value indicating whether dependent clone volumes created from intermediate snapshots should be deleted when a volume is restored from snapshot.

DeleteIntermediateData (boolean) –

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.

SourceSnapshotARN (string) –

The Amazon Resource Name (ARN) for a given resource. ARNs uniquely identify Amazon Web Services resources. We require an ARN when you need to specify a resource unambiguously across all of Amazon Web Services. For more information, see Amazon Resource Names (ARNs) in the Amazon Web Services General Reference.

DestinationSnapshot (string) –

The ID of the snapshot that’s being copied or was most recently copied to the destination volume.

CopyStrategy (string) –

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.

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

TargetSnapshotValues (dict) –

A snapshot of an Amazon FSx for OpenZFS volume.

TotalTransferBytes (integer) –

The number of bytes that have transferred for the FSx for OpenZFS snapshot that you’re copying.

RemainingTransferBytes (integer) –

The remaining bytes to transfer for the FSx for OpenZFS snapshot that you’re copying.

Exceptions

FSx.Client.exceptions.BadRequest

FSx.Client.exceptions.VolumeNotFound

FSx.Client.exceptions.ServiceLimitExceeded

FSx.Client.exceptions.InternalServerError